Commit 7d3cd2dd authored by mh's avatar mh
Browse files

add info to contribute

parent fe56593d
Pipeline #363 passed with stages
in 1 minute and 2 seconds
......@@ -2,9 +2,57 @@
This is the source for the help pages at immerda.ch. This Readme is at the moment mainly in english to describe how to contribute to it. Translations are welcome though.
## License
## Contribute
All documentation is licensed under the GNU Free Documentation License.
If you are part of the documentation project it is very simple:
* Edit the file (e.g. directly in gitlab)
* Commit (and push)
* Changes will be generated and published automatically
If you are not part of the documentation project, you can propose changes by forking.
For this we are adopting a git flow. In short this means the following:
* You fork the project.
* Make your changes
* Propose a merge request
* We merge and it will get published
## Content organization
You find all content under `content/LANG` within markdown files. The subfolder structure represents the menu structure on the left. Each folder should contain a `_index.md` file that servers as the main index page for that sub-section.
The structure between the different language folders should match.
Each file starts with a certain set of metadata between the `---` lines. Important keys for that metadata section are:
```
title: Title of the page
weight: 10
```
* `title` represents the page's title (obviously)
* `weight` orders all the different pages on the same level according to their weight (lowest weight has highest prio)
### Example content
A simple way to start a new page is to copy the following content.
```
---
title: "Hilfeseiten"
weight: 5
---
# Die Hilfeseiten
Lorem Ipsum.
```
### Naming
We are naming the files in english. It is important that all sections and files of the different languages have the same filename so hugo easily interlink them within the language drop down.
## Technical
......@@ -14,15 +62,10 @@ Refer to that documentation on how different aspects work.
The live version is built automatically from the latest master branch.
## Contribute
We are adopting a git flow. In short this means the following:
* You fork the project.
* Make your changes
* Propose a merge request
* We merge
## Translate
Translation are ultimately a goal, though as it is currently in an early stage, we are focussing on german content.
## License
All documentation is licensed under the GNU Free Documentation License.
---
title: "Hilfeseiten"
date: 2019-05-08T20:57:30+02:00
weight: 5
---
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment