Updating contribution guide with general guidelines
Compare changes
+ 43
− 0
@@ -82,6 +82,48 @@ python -m pyspelling -j4
@@ -82,6 +82,48 @@ python -m pyspelling -j4
This site makes use of a few [MkDocs](https://www.mkdocs.org) markdown extensions, which you can see under `markdown_extensions:` in the [mkdocs.yml](mkdocs.yml) file, and the [macros](https://mkdocs-macros-plugin.readthedocs.io/en/latest/) plugin. This plugin allows a lot more complicated behaviour than base MkDocs, and also reads in the [variables](data/variables.yaml) file.
This site makes use of a few [MkDocs](https://www.mkdocs.org) markdown extensions, which you can see under `markdown_extensions:` in the [mkdocs.yml](mkdocs.yml) file, and the [macros](https://mkdocs-macros-plugin.readthedocs.io/en/latest/) plugin. This plugin allows a lot more complicated behaviour than base MkDocs, and also reads in the [variables](data/variables.yaml) file.
@@ -93,3 +135,4 @@ Each merge request is deployed into a staging area using [GitLab Pages parallel
@@ -93,3 +135,4 @@ Each merge request is deployed into a staging area using [GitLab Pages parallel
For tips about the migration of the ATLAS software documentation from Jekyll to MkDocs, please have a look at the [Migration](MIGRATION.md) document.