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

Update how to contribute

parent 7f601b0a
Branches
Tags v1.4.0
1 merge request!7How to contribute
Pipeline #174274 waiting for manual action
# Documentation overview # Documentation overview
## Structure of the documentation ## Structure of the documentation
Thanks to the [Monorepo][1] plugin for the mkdocs platform, it is possible to enable a documentation structure consisting of sub-topic-related documentation. Thanks to the [Monorepo][1] plugin for the mkdocs platform, it is possible to create a documentation structure consisting of sub-topic-related documentation.
The documentation is organized to categories (2nd level folders) and topics (3rd level folders). See following output for reference. The documentation is organized to categories (2nd level folders) and topics (3rd level folders). See following output for reference.
```console ```console
...@@ -26,7 +26,7 @@ The documentation is organized to categories (2nd level folders) and topics (3rd ...@@ -26,7 +26,7 @@ The documentation is organized to categories (2nd level folders) and topics (3rd
|── mkdocs.yml |── mkdocs.yml
``` ```
Earch e-INFRA service is represented by it's own topic, therefore folder structure consisting of `mkdocs.yml` file and `docs` folder. Each e-INFRA service is represented by it's own topic, therefore folder structure consisting of `mkdocs.yml` file and `docs` folder.
## Documentation configuration - mkdocs.yml ## Documentation configuration - mkdocs.yml
...@@ -44,6 +44,13 @@ It is possible to build whole documentation or just it's small fraction. ...@@ -44,6 +44,13 @@ It is possible to build whole documentation or just it's small fraction.
[See how to build documentation here][2]. [See how to build documentation here][2].
## Publishing changes
Once the changes to the documentation has beed made locally or within the Gitlab graphical editor, it is important to publish it a make it visible on the main documentation domain. The changes will go through automatic checks and final review of our editor staff.
[Please refer to this documentation page to see how][3]
[1]: https://github.com/backstage/mkdocs-monorepo-plugin [1]: https://github.com/backstage/mkdocs-monorepo-plugin
[2]: ./set-up-and-work-localy [2]: ../set-up-and-work-localy
\ No newline at end of file [3]: ../push-contribution-to-the-repository
\ No newline at end of file
...@@ -7,8 +7,8 @@ based on the user's proficiency with Git/GitLab. From the least to most proficie ...@@ -7,8 +7,8 @@ based on the user's proficiency with Git/GitLab. From the least to most proficie
- [Simple Merge Request (using GitLab web interface)](/#simple-merge-request-using-gitlab-web-interface) - [Simple Merge Request (using GitLab web interface)](/#simple-merge-request-using-gitlab-web-interface)
## Prerequisites ## Prerequisites
- [Git][4] - [Git][1]
- [Docker][5] - [Docker][2]
## Forking Repository ## Forking Repository
...@@ -40,7 +40,29 @@ Use our `start.sh`, which will use our production [Docker][4] container and will ...@@ -40,7 +40,29 @@ Use our `start.sh`, which will use our production [Docker][4] container and will
!!! note !!! note
Edits will be shown live in your browser window, no need to restart the server. Edits will be shown live in your browser window, no need to restart the server.
### Partial documentation building
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>` 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 ```console
./start.sh -f /docs/compute/kubernetes/mkdocs.yml ./start.sh -f /docs/compute/kubernetes/mkdocs.yml
``` ```
### Publishing changes
#### 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 --set-upstream origin my_change
```
#### Submit Changes
Create a *Merge Request* via GitLab @ ICS MU.
[1]: https://git-scm.com/downloads
[2]: https://docs.docker.com/get-docker/
[3]: https://docs.e-infra.cz
[4]: ../push-contribution-to-the-repository
\ No newline at end of file
# Documentation style # Documentation style
1. A This section focuses on the best practise of usage of various components (code blocks, notes, diagrams, ...) used within the documentation.
2. B
\ No newline at end of file !!! note
The section is work in progress, please, be patient.
\ No newline at end of file
# Publish changes to the main repository # Contribute within Gitlab GUI
### 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 --set-upstream origin my_change
```
### Submit Changes
Create a *Merge Request* via GitLab @ ICS MU.
## Simple Merge Request (using GitLab web interface) ## Simple Merge Request (using GitLab web interface)
...@@ -27,10 +14,4 @@ under the Table of Content on the right side of the respective page; ...@@ -27,10 +14,4 @@ under the Table of Content on the right side of the respective page;
## Contacting Support ## Contacting Support
The easiest way is to contact us at [support@e-infra.cz][3] with your contribution. The easiest way is to contact us at [support@e-infra.cz][3] with your contribution.
\ No newline at end of file
[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/
\ No newline at end of file
...@@ -5,5 +5,6 @@ nav: ...@@ -5,5 +5,6 @@ nav:
- e-INFRA contributor guide: - e-INFRA contributor guide:
- Overview: ./contribute/overview.md - Overview: ./contribute/overview.md
- Set up and work localy: ./contribute/set-up-and-work-localy.md - Set up and work localy: ./contribute/set-up-and-work-localy.md
- Work within the GitLab UI: ./contribute/work-within-gitlab-ui.md
- Writing practices: ./contribute/writing-practices.md - Writing practices: ./contribute/writing-practices.md
- Style guide: ./contribute/style.md - Style guide: ./contribute/style.md
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment