From cdc363386bf2d307b20fff27e19b78cf38dad8d0 Mon Sep 17 00:00:00 2001
From: ddamiron <ddamiron@sii.fr>
Date: Tue, 11 Jun 2019 16:54:14 +0200
Subject: [PATCH] update README file update banner color using mkdocs.yml
---
README.md | 33 ++++++++++++++++++++++++++++++++-
docs/index.md | 30 ------------------------------
mkdocs.yml | 7 ++++++-
3 files changed, 38 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
index 88330d0..9c3730c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,32 @@
-# Portail Data documentation
\ No newline at end of file
+# Portail Data documentation
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `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.
+ docs/
+ index.md # The documentation homepage.
+ ... # Other markdown pages, images and other files.
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 62049be..7a8e1d8 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,32 +1,2 @@
# Welcome to the functional documentation of portail-data
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `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.
- docs/
- index.md # The documentation homepage.
- ... # Other markdown pages, images and other files.
diff --git a/mkdocs.yml b/mkdocs.yml
index 378eda7..82a314b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,6 +4,9 @@ site_author: MkDocs Team
theme:
name: 'material'
+ palette:
+ primary: 'grey'
+ accent: 'amber'
nav:
- Home: index.md
@@ -15,7 +18,9 @@ nav:
- Monitoring: architecture/monitoring.md
- Web-app: architecture/web-app.md
- Service:
- - authentification: architecture/service/autentification.md
+ - authentification: architecture/service/authentication.md
+ - organizations: architecture/service/organizations.md
+ - resources: architecture/service/resources.md
- Elasticsearch:
- Indexer: architecture/service/elasticsearch/indexer.md
- About:
--
GitLab