diff --git a/docs/index.md b/docs/index.md index 9b45a3aa0cb94b08a3ded7e2dc11ad2ec7f129e8..62049be0fe22a5f1722a9d2514580b4526678d74 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,23 @@ * `mkdocs build` - Build the documentation site. * `mkdocs help` - Print this help message. +## Setting files hierarchy + inside mkdocs.yml use the key nav: to configure the md files hierarchy + + nav: + - Home: index.md + - Architecture Guide: + - Admin-gui: architecture/admin-gui.md + - Admin-tools: architecture/admin-tools.md + - Api-gateway: architecture/api-gateway.md + - CMS: architecture/cms.md + - Monitoring: architecture/monitoring.md + - Web-app: architecture/web-app.md + - Service: + - authentification: architecture/service/autentification.md + - Elasticsearch: + - Indexer: architecture/service/elasticsearch/indexer.md + ## Project layout mkdocs.yml # The main file and configuration file. diff --git a/mkdocs.yml b/mkdocs.yml index 919dff8357fa7d049bca630b245819f2b5c6e1d7..378eda7c0340b54d13e03fda5937ecf7e5fb0d2e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,24 @@ -site_name: portail data functional documentation +site_name: Portail Data Functional Documentation +site_description: Portail Data Project Documentation with Markdown. +site_author: MkDocs Team + theme: name: 'material' + +nav: + - Home: index.md + - Architecture Guide: + - Admin-gui: architecture/admin-gui.md + - Admin-tools: architecture/admin-tools.md + - Api-gateway: architecture/api-gateway.md + - CMS: architecture/cms.md + - Monitoring: architecture/monitoring.md + - Web-app: architecture/web-app.md + - Service: + - authentification: architecture/service/autentification.md + - Elasticsearch: + - Indexer: architecture/service/elasticsearch/indexer.md + - About: + - Gitflow: miscellaneous/gitflow-ci-cd.md + - VSCode: miscellaneous/vscode-settings.md + - Webapp: miscellaneous/webapp-auth.md