From 5c5f4e8e6ec5ff82f5ad183ae47c52d81d184405 Mon Sep 17 00:00:00 2001
From: Yoan VALLET <ext.sopra.yvallet@grandlyon.com>
Date: Mon, 6 Jul 2020 14:53:52 +0200
Subject: [PATCH] init files hierarchy
---
.gitignore | 2 ++
README.md | 31 ++++++++++---------
.../description.md} | 0
.../{miscellaneous => application}/gitflow.md | 0
.../launch_local_application.md} | 0
.../launch_local_konnector.md} | 0
.../setup_your_environment.md} | 0
docs/index.md | 2 +-
.../enedis.md => konnectors/egl.md} | 0
.../grdf.md => konnectors/enedis.md} | 0
.../grdf.md} | 0
.../architecture.md} | 0
.../cozy.md} | 0
.../doctypes.md} | 0
.../environments.md} | 0
docs/proxy/description.md | 0
mkdocs.yml | 31 ++++++++++---------
17 files changed, 37 insertions(+), 29 deletions(-)
create mode 100644 .gitignore
rename docs/{architecture/architecture-home.md => application/description.md} (100%)
rename docs/{miscellaneous => application}/gitflow.md (100%)
rename docs/{architecture/client.md => getting_started/launch_local_application.md} (100%)
rename docs/{architecture/cozy.md => getting_started/launch_local_konnector.md} (100%)
rename docs/{architecture/konnectors/egl.md => getting_started/setup_your_environment.md} (100%)
rename docs/{architecture/konnectors/enedis.md => konnectors/egl.md} (100%)
rename docs/{architecture/konnectors/grdf.md => konnectors/enedis.md} (100%)
rename docs/{architecture/konnectors/konnectors-intro.md => konnectors/grdf.md} (100%)
rename docs/{miscellaneous/devenv.md => project_architecture/architecture.md} (100%)
rename docs/{miscellaneous/glossary.md => project_architecture/cozy.md} (100%)
rename docs/{miscellaneous/tools.md => project_architecture/doctypes.md} (100%)
rename docs/{miscellaneous/vscode-settings.md => project_architecture/environments.md} (100%)
create mode 100644 docs/proxy/description.md
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ee61d28
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+# Build
+site/
\ No newline at end of file
diff --git a/README.md b/README.md
index 66e8561..b6c1e2f 100644
--- a/README.md
+++ b/README.md
@@ -13,21 +13,24 @@
nav:
- Home: index.md
+ - Getting started:
+ - Setup your environment: getting_started/setup_your_environment.md
+ - Launch the application on local : getting_started/launch_local_application.md
+ - Launch a konnector on local : getting_started/launch_local_konnector.md
- Project Architecture:
- - Introduction: architecture/architecture-home.md
- - Client: architecture/client/client.md
- - Cozy: architecture/cozy/cozy.md
- - Konnectors:
- - Introduction: architecture/konnectors/konnectors-intro.md
- - Enedis: architecture/konnectors/enedis.md
- - EGL: architecture/konnectors/egl.md
- - GDRF: architecture/konnectors/gdrf.md
- - About:
- - Gitflow: miscellaneous/gitflow.md
- - Glossary: miscellaneous/glossary.md
- - Tools: miscellaneous/tools.md
- - Environment: miscellaneous/devenv.md
- - VSCode: miscellaneous/vscode-settings.md
+ - Architecture : project_architecture/architecture.md
+ - Cozy : project_architecture/cozy.md
+ - Environments : project_architecture/environments.md
+ - DocTypes : project_architecture/doctypes.md
+ - Application:
+ - Description: application/description.md
+ - Gitflow: application/gitflow.md
+ - Konnectors:
+ - Enedis: konnectors/enedis.md
+ - GRDF: konnectors/grdf.md
+ - Eau du Grand Lyon: konnectors/egl.md
+ - Proxy:
+ - Description: proxy/description.md
## Project layout
diff --git a/docs/architecture/architecture-home.md b/docs/application/description.md
similarity index 100%
rename from docs/architecture/architecture-home.md
rename to docs/application/description.md
diff --git a/docs/miscellaneous/gitflow.md b/docs/application/gitflow.md
similarity index 100%
rename from docs/miscellaneous/gitflow.md
rename to docs/application/gitflow.md
diff --git a/docs/architecture/client.md b/docs/getting_started/launch_local_application.md
similarity index 100%
rename from docs/architecture/client.md
rename to docs/getting_started/launch_local_application.md
diff --git a/docs/architecture/cozy.md b/docs/getting_started/launch_local_konnector.md
similarity index 100%
rename from docs/architecture/cozy.md
rename to docs/getting_started/launch_local_konnector.md
diff --git a/docs/architecture/konnectors/egl.md b/docs/getting_started/setup_your_environment.md
similarity index 100%
rename from docs/architecture/konnectors/egl.md
rename to docs/getting_started/setup_your_environment.md
diff --git a/docs/index.md b/docs/index.md
index b5b3a6a..c0506ee 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,7 +3,7 @@
LLLE - Ecolyo is a multi-fluid application solution towards users of the grand lyon metropolis to monitor and optimize their energy consumption.
!!! info ""
- If you are a new developper tasked to work on this project, check the [recommended tools](./miscellaneous/tools.md) and setup your [environment](./miscellaneous/devenv.md). Then we also suggest you to get familiar with the [vocabulary](./miscellaneous/glossary.md) used to build this app.
+ If you are a new developper tasked to work on this project, check the [setup your environment](./getting_started/setup_your_environment.md) and [setup your environment](./getting_started/launch_local_application.md) to start the application.
## Contact
diff --git a/docs/architecture/konnectors/enedis.md b/docs/konnectors/egl.md
similarity index 100%
rename from docs/architecture/konnectors/enedis.md
rename to docs/konnectors/egl.md
diff --git a/docs/architecture/konnectors/grdf.md b/docs/konnectors/enedis.md
similarity index 100%
rename from docs/architecture/konnectors/grdf.md
rename to docs/konnectors/enedis.md
diff --git a/docs/architecture/konnectors/konnectors-intro.md b/docs/konnectors/grdf.md
similarity index 100%
rename from docs/architecture/konnectors/konnectors-intro.md
rename to docs/konnectors/grdf.md
diff --git a/docs/miscellaneous/devenv.md b/docs/project_architecture/architecture.md
similarity index 100%
rename from docs/miscellaneous/devenv.md
rename to docs/project_architecture/architecture.md
diff --git a/docs/miscellaneous/glossary.md b/docs/project_architecture/cozy.md
similarity index 100%
rename from docs/miscellaneous/glossary.md
rename to docs/project_architecture/cozy.md
diff --git a/docs/miscellaneous/tools.md b/docs/project_architecture/doctypes.md
similarity index 100%
rename from docs/miscellaneous/tools.md
rename to docs/project_architecture/doctypes.md
diff --git a/docs/miscellaneous/vscode-settings.md b/docs/project_architecture/environments.md
similarity index 100%
rename from docs/miscellaneous/vscode-settings.md
rename to docs/project_architecture/environments.md
diff --git a/docs/proxy/description.md b/docs/proxy/description.md
new file mode 100644
index 0000000..e69de29
diff --git a/mkdocs.yml b/mkdocs.yml
index e1147cb..9415c0a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -21,18 +21,21 @@ markdown_extensions:
nav:
- Home: index.md
+ - Getting started:
+ - Setup your environment: getting_started/setup_your_environment.md
+ - Launch the application on local : getting_started/launch_local_application.md
+ - Launch a konnector on local : getting_started/launch_local_konnector.md
- Project Architecture:
- - Introduction: architecture/architecture-home.md
- - Client: architecture/client/client.md
- - Cozy: architecture/cozy/cozy.md
- - Konnectors:
- - Introduction: architecture/konnectors/konnectors-intro.md
- - Enedis: architecture/konnectors/enedis.md
- - EGL: architecture/konnectors/egl.md
- - GDRF: architecture/konnectors/gdrf.md
- - About:
- - Gitflow: miscellaneous/gitflow.md
- - Glossary: miscellaneous/glossary.md
- - Tools: miscellaneous/tools.md
- - Environment: miscellaneous/devenv.md
- - VSCode: miscellaneous/vscode-settings.md
+ - Architecture : project_architecture/architecture.md
+ - Cozy : project_architecture/cozy.md
+ - Environments : project_architecture/environments.md
+ - DocTypes : project_architecture/doctypes.md
+ - Application:
+ - Description: application/description.md
+ - Gitflow: application/gitflow.md
+ - Konnectors:
+ - Enedis: konnectors/enedis.md
+ - GRDF: konnectors/grdf.md
+ - Eau du Grand Lyon: konnectors/egl.md
+ - Proxy:
+ - Description: proxy/description.md
--
GitLab