From a1b60971520957db5a5eb0bab50823892fdc26c9 Mon Sep 17 00:00:00 2001 From: William Desportes Date: Fri, 13 Aug 2021 14:14:26 +0200 Subject: [PATCH] docs: Add a contributing docs guide (#2129) --- docs/content/contributing/documentation.md | 51 +++++++++++++++++++++- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/docs/content/contributing/documentation.md b/docs/content/contributing/documentation.md index e9470de1..8640e0de 100644 --- a/docs/content/contributing/documentation.md +++ b/docs/content/contributing/documentation.md @@ -2,5 +2,52 @@ title: 'Contributing | Documentation' --- -!!! todo - This section should provide a detailed step by step guide on how to contribute to documentation \ No newline at end of file +## Prerequisites + +You will need have Python and Python pip installed. Or just docker. + +## Building and serving the documentation + +This tutorial was written using Python `2.7.18` and Python pip `20.3.4`. +And Docker `19.03.6`. + +### Python way + +#### Install the modules + +The documentation builder + +```sh +pip install mkdocs +``` + +Now the theme + +```sh +pip install mkdocs-material +``` + +#### Serve + +!!! note "Note: be sure to be in the docs folder (`cd ./docs/`)" + +```sh +mkdocs serve +``` + +Wait for it to build and open the URL in your browser. +Each change will be hot-reloaded onto the page you view, just edit, save and look at the result. + +### Docker way + +Using the official image ([squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material)) for our documentation theme. + +#### Serve + +!!! note "Note: be sure to be in the docs folder (`cd ./docs/`)" + +```sh +docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material +``` + +Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.