Skip to content
Snippets Groups Projects
Verified Commit 9aa2167f authored by Adrián Rošinec's avatar Adrián Rošinec
Browse files

Added contributors guide structure.

parent 99ac7b5a
No related branches found
No related tags found
1 merge request!7How to contribute
Pipeline #171084 failed
---
hide:
- navigation
- toc
- breadcrumbs
---
......
# Contribute To Documentation
# Contribute to the documentation
There are several ways to contribute to the documentation
based on the user's proficiency with Git/GitLab. From the least to most proficient, these are:
based on the user's proficiency with Git/GitLab. From the least to most proficient, these are:
## Forking Repository
- [Forking Repository](#forking-repository)
- [Simple Merge Request (using GitLab web interface)](/#simple-merge-request-using-gitlab-web-interface)
Since this documentation is built with [MkDocs Material][1], you need to install it first. See the [official installation instructions][2].
## Prerequisites
- [Git][4]
- [Docker][5]
Once you have MkDocs Material installed,
proceed with the following steps:
## Forking Repository
### Fork Repository
See GitLab @ ICS MU for details. This will create your own clone of our repository where you will be able to make changes. Once you are happy with your changes, use GitLab to submit them to our original repository.
......@@ -23,32 +25,40 @@ git clone git@gitlab.ics.muni.cz:einfra-docs/documentation.git
### Create New Branch
```console
# in `mkdocs-material`
# in `documentation` folder
git checkout -b my_change
```
### Make Changes & Run Local Server
Use our `start.sh`, which will use our production [Docker][4] container and will create production version server of the documentation locally on your PC.
```console
# in `mkdocs-material`
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
./start.sh
```
!!! note
Edits will be shown live in your browser window, no need to restart the server.
If you don't want to build the whole documentation (due to it's big build time), you can choose to build only subset of the whole documentation site by using argument `-f <path to mkdocs.yml of subdocumnetation>`
```console
./start.sh -f /docs/compute/kubernetes/mkdocs.yml
```
### Commit and Push Changes
If you are satisfied with your changes and you did build the whole documentation to review you changes in the context of the whole site commit and push changes to main respository:
```console
git commit -am "Commit message"
git push origin my_change
git push --set-upstream origin my_change
```
### Submit Changes
Create a *Merge Request* via GitLab @ ICS MU.
## Simple Merge Request
## Simple Merge Request (using GitLab web interface)
This option is suitable for less extensive contribution
(e.g. a section or a subsection) of an already existing page).
......@@ -67,3 +77,5 @@ The easiest way is to contact us at [support@e-infra.cz][3] with your contributi
[1]: https://github.com/squidfunk/mkdocs-material
[2]: https://squidfunk.github.io/mkdocs-material/getting-started/
[3]: mailto:support@e-infra.cz
[4]: https://git-scm.com/downloads
[5]: https://docs.docker.com/get-docker/
# Documentation style
1. A
2. B
\ No newline at end of file
site_name: "about"
nav:
- Overview: about-us.md
- e-INFRA contributor guide:
- Set up and work localy: ./contribute/overview.md
- Writing practices: ./contribute/best-practices.md
- Style guide: ./contribute/style.md
\ No newline at end of file
......@@ -56,9 +56,7 @@ nav:
- Sensitive: '!include ./docs/compute/sensitive/mkdocs.yml'
- Storage: '!include ./docs/storage/mkdocs.yml'
- Managed services: '!include ./docs/managed/mkdocs.yml'
- General Information:
- About Us: about-us.md
- How To Contribute: contribute.md
- General Information: '!include ./docs/about-us/mkdocs.yml'
#extra:
# disqus: 'test-3whnesz3gq'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment