From f9f7a79e906aa99eba3e1b2a37a633740d451b7a Mon Sep 17 00:00:00 2001
From: ddamiron <ddamiron@sii.fr>
Date: Tue, 11 Jun 2019 15:23:56 +0200
Subject: [PATCH] update md files hierarchy add Dockerfile for mkdocs add
mkdocs.yml for mkdocs add pip install mkdocs-material
---
Dockerfile | 20 ++++++++++++++++++
docker-compose.yml | 9 ++++++++
.../accessibility/accessibility.md | 0
.../architecture}/admin-gui.md | 0
.../architecture}/admin-tools.md | 0
.../architecture}/api-gateway.md | 0
{architecture => docs/architecture}/cms.md | 2 +-
.../architecture}/monitoring.md | 0
.../architecture}/services/authentication.md | 2 +-
.../services/csv-catalog-downloader.md | 0
.../services/elasticsearch/elasticsearch.md | 0
.../services/elasticsearch/indexer.md | 0
.../services/legacy-auth-middleware.md | 0
.../architecture}/services/mail.md | 0
.../architecture}/services/media-library.md | 0
.../architecture}/services/organizations.md | 2 +-
.../architecture}/services/resources.md | 2 +-
.../architecture}/web-app.md | 0
.../assets}/authentication-service.png | Bin
{assets => docs/assets}/ghost-logo.png | Bin
.../assets}/organizations-service.png | Bin
.../beta-deployment/beta-deployment.md | 0
.../miscellaneous/gitflow-ci-cd.md | 0
.../miscellaneous/sass-recommandation.md | 0
.../miscellaneous/vscode-settings.md | 0
.../miscellaneous/webapp-auth.md | 0
mkdocs.yml | 3 +++
27 files changed, 36 insertions(+), 4 deletions(-)
create mode 100644 Dockerfile
create mode 100644 docker-compose.yml
rename accessibility.md => docs/accessibility/accessibility.md (100%)
rename {architecture => docs/architecture}/admin-gui.md (100%)
rename {architecture => docs/architecture}/admin-tools.md (100%)
rename {architecture => docs/architecture}/api-gateway.md (100%)
rename {architecture => docs/architecture}/cms.md (96%)
rename {architecture => docs/architecture}/monitoring.md (100%)
rename {architecture => docs/architecture}/services/authentication.md (97%)
rename {architecture => docs/architecture}/services/csv-catalog-downloader.md (100%)
rename {architecture => docs/architecture}/services/elasticsearch/elasticsearch.md (100%)
rename {architecture => docs/architecture}/services/elasticsearch/indexer.md (100%)
rename {architecture => docs/architecture}/services/legacy-auth-middleware.md (100%)
rename {architecture => docs/architecture}/services/mail.md (100%)
rename {architecture => docs/architecture}/services/media-library.md (100%)
rename {architecture => docs/architecture}/services/organizations.md (96%)
rename {architecture => docs/architecture}/services/resources.md (97%)
rename {architecture => docs/architecture}/web-app.md (100%)
rename {assets => docs/assets}/authentication-service.png (100%)
rename {assets => docs/assets}/ghost-logo.png (100%)
rename {assets => docs/assets}/organizations-service.png (100%)
rename beta-deployment.md => docs/beta-deployment/beta-deployment.md (100%)
rename gitflow-ci-cd.md => docs/miscellaneous/gitflow-ci-cd.md (100%)
rename sass-recommandation.md => docs/miscellaneous/sass-recommandation.md (100%)
rename vscode-settings.md => docs/miscellaneous/vscode-settings.md (100%)
rename webapp-auth.md => docs/miscellaneous/webapp-auth.md (100%)
create mode 100644 mkdocs.yml
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..5fe2165
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,20 @@
+
+FROM python:3.6.8-alpine3.9
+
+# Set build directory
+WORKDIR /app
+
+# add the current directory to the container as /app
+ADD . /docs
+# Perform build and cleanup artifacts
+RUN pip install mkdocs && pip install mkdocs-material
+
+# Set working directory
+WORKDIR /docs
+
+# Expose MkDocs development server port
+EXPOSE 8000
+
+# Start development server by default
+ENTRYPOINT ["mkdocs"]
+CMD ["serve", "--dev-addr=0.0.0.0:8000"]
\ No newline at end of file
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..616e1f1
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,9 @@
+version: '3.6'
+
+services:
+ mkdocs:
+ build:
+ context: ./
+ ports:
+ - 2077:8000
+ restart: on-failure
\ No newline at end of file
diff --git a/accessibility.md b/docs/accessibility/accessibility.md
similarity index 100%
rename from accessibility.md
rename to docs/accessibility/accessibility.md
diff --git a/architecture/admin-gui.md b/docs/architecture/admin-gui.md
similarity index 100%
rename from architecture/admin-gui.md
rename to docs/architecture/admin-gui.md
diff --git a/architecture/admin-tools.md b/docs/architecture/admin-tools.md
similarity index 100%
rename from architecture/admin-tools.md
rename to docs/architecture/admin-tools.md
diff --git a/architecture/api-gateway.md b/docs/architecture/api-gateway.md
similarity index 100%
rename from architecture/api-gateway.md
rename to docs/architecture/api-gateway.md
diff --git a/architecture/cms.md b/docs/architecture/cms.md
similarity index 96%
rename from architecture/cms.md
rename to docs/architecture/cms.md
index 1424d65..8baa1f3 100644
--- a/architecture/cms.md
+++ b/docs/architecture/cms.md
@@ -4,7 +4,7 @@ For all the editorial content on the portal one CMS is used to offer the possibi
## Ghost: headless CMS
-
+
The choice went for the open source CMS [Ghost](https://ghost.org/), replacing Wordpress as our first choice at the beginning of the project.
Whereas it's not perfect and there is still room for improvement, this is a great tool to use to create content in a beautiful user interface. The API allows us to get all the information needed for the web application by a REST API.
diff --git a/architecture/monitoring.md b/docs/architecture/monitoring.md
similarity index 100%
rename from architecture/monitoring.md
rename to docs/architecture/monitoring.md
diff --git a/architecture/services/authentication.md b/docs/architecture/services/authentication.md
similarity index 97%
rename from architecture/services/authentication.md
rename to docs/architecture/services/authentication.md
index a2943c2..63735b5 100644
--- a/architecture/services/authentication.md
+++ b/docs/architecture/services/authentication.md
@@ -13,7 +13,7 @@ This service also provides endpoints to retrieve and update a user profile.
## How it works
-
+
The entrypoint of the service is a REST API provided by a [NestJS](https://github.com/nestjs/nest) application. It depends on two other services:
diff --git a/architecture/services/csv-catalog-downloader.md b/docs/architecture/services/csv-catalog-downloader.md
similarity index 100%
rename from architecture/services/csv-catalog-downloader.md
rename to docs/architecture/services/csv-catalog-downloader.md
diff --git a/architecture/services/elasticsearch/elasticsearch.md b/docs/architecture/services/elasticsearch/elasticsearch.md
similarity index 100%
rename from architecture/services/elasticsearch/elasticsearch.md
rename to docs/architecture/services/elasticsearch/elasticsearch.md
diff --git a/architecture/services/elasticsearch/indexer.md b/docs/architecture/services/elasticsearch/indexer.md
similarity index 100%
rename from architecture/services/elasticsearch/indexer.md
rename to docs/architecture/services/elasticsearch/indexer.md
diff --git a/architecture/services/legacy-auth-middleware.md b/docs/architecture/services/legacy-auth-middleware.md
similarity index 100%
rename from architecture/services/legacy-auth-middleware.md
rename to docs/architecture/services/legacy-auth-middleware.md
diff --git a/architecture/services/mail.md b/docs/architecture/services/mail.md
similarity index 100%
rename from architecture/services/mail.md
rename to docs/architecture/services/mail.md
diff --git a/architecture/services/media-library.md b/docs/architecture/services/media-library.md
similarity index 100%
rename from architecture/services/media-library.md
rename to docs/architecture/services/media-library.md
diff --git a/architecture/services/organizations.md b/docs/architecture/services/organizations.md
similarity index 96%
rename from architecture/services/organizations.md
rename to docs/architecture/services/organizations.md
index 55e0fe7..133676a 100644
--- a/architecture/services/organizations.md
+++ b/docs/architecture/services/organizations.md
@@ -8,7 +8,7 @@ In our application, one organization is usually a provider of data, used in the
## How it works
-
+
The entrypoint of the service is a REST API provided by a [NestJS](https://github.com/nestjs/nest) application. This backend application interacts with a PostgresSQL database through an ORM called [TypeORM](https://github.com/typeorm/typeorm).
diff --git a/architecture/services/resources.md b/docs/architecture/services/resources.md
similarity index 97%
rename from architecture/services/resources.md
rename to docs/architecture/services/resources.md
index 4986784..836f9f4 100644
--- a/architecture/services/resources.md
+++ b/docs/architecture/services/resources.md
@@ -10,7 +10,7 @@ the output of a Web Feature Service (WFS), standard service providing an interfa
## How it works
-
+
The entrypoint of the service is a REST API provided by a [NestJS](https://github.com/nestjs/nest) application. This backend application interacts with a PostgresSQL database through an ORM called [TypeORM](https://github.com/typeorm/typeorm).
diff --git a/architecture/web-app.md b/docs/architecture/web-app.md
similarity index 100%
rename from architecture/web-app.md
rename to docs/architecture/web-app.md
diff --git a/assets/authentication-service.png b/docs/assets/authentication-service.png
similarity index 100%
rename from assets/authentication-service.png
rename to docs/assets/authentication-service.png
diff --git a/assets/ghost-logo.png b/docs/assets/ghost-logo.png
similarity index 100%
rename from assets/ghost-logo.png
rename to docs/assets/ghost-logo.png
diff --git a/assets/organizations-service.png b/docs/assets/organizations-service.png
similarity index 100%
rename from assets/organizations-service.png
rename to docs/assets/organizations-service.png
diff --git a/beta-deployment.md b/docs/beta-deployment/beta-deployment.md
similarity index 100%
rename from beta-deployment.md
rename to docs/beta-deployment/beta-deployment.md
diff --git a/gitflow-ci-cd.md b/docs/miscellaneous/gitflow-ci-cd.md
similarity index 100%
rename from gitflow-ci-cd.md
rename to docs/miscellaneous/gitflow-ci-cd.md
diff --git a/sass-recommandation.md b/docs/miscellaneous/sass-recommandation.md
similarity index 100%
rename from sass-recommandation.md
rename to docs/miscellaneous/sass-recommandation.md
diff --git a/vscode-settings.md b/docs/miscellaneous/vscode-settings.md
similarity index 100%
rename from vscode-settings.md
rename to docs/miscellaneous/vscode-settings.md
diff --git a/webapp-auth.md b/docs/miscellaneous/webapp-auth.md
similarity index 100%
rename from webapp-auth.md
rename to docs/miscellaneous/webapp-auth.md
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..919dff8
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,3 @@
+site_name: portail data functional documentation
+theme:
+ name: 'material'
--
GitLab