UtrechtUniversity / containerplatform-docs

Container Platform public documentation

Containerplatform-docs

Container Platform public documentation

Instructions to contribute to this repository and our documentation site.

1. clone this repository
2. create a new branch
3. make your changes

• Choose which file you want to edit (you can choose all except the index.md file) you can find the files in the docs folder.
• Add ## to the end of the file, to create a new header and place your content below it. If you want to make subheaders use ### or ####. Never use # as this is the main header of the page.
• Make sure you use the correct Markdown syntax. See the links below for more information.
• If you want to include images, place them in the docs/images folder and reference them in your markdown file.
  example:

![cm_hs_avatar_corporate.png](./images/cm_hs_avatar_corporate.png)

4. push your changes to the repository
5. create a pull request
6. wait for the pull request to be reviewed and merged
7. your changes will be visible on the documentation site after approval Container Platform docs site

Check these sites on how markdown works:

github_markdown

markdownguide