Overview

This project contains the content for the Thales Group organization documentation (github pages).

It relies on https://www.mkdocs.org/ and consists of several markdown files that will be hosted on https://thalesgroup.github.io/

Branches

• main branch (default) is used to update the content through the different markdown files composing the documentation
• gh-pages branch is used for output content, result of the mkdocs build

Updating content procedure

1. Clone the repository and checkout the main branch
2. Install mkdocs : https://www.mkdocs.org/#installation
3. Install the material theme: pip install mkdocs-material
4. If needed, update mkdocs.yml descriptor file
5. Add/update markdown files in the docs/ directory
6. Test the documentation by launching mkdocs serve from the root directory
7. Open a web browser at http://localhost:8000
8. Browse and test the documentation structure, navigation and content
9. Commit your local modifications and open a pull request against the main branch