diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..ee61d28b271e366f1a6f29885862388acffefd6a --- /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 66e8561f4e41c32220f6a5374459132c3bf4ca4d..b6c1e2fc61d735531fdfffe5454cc866199e9a88 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 b5b3a6a10e89e93896928862551687f1004f9e96..c0506ee435ed4cbe57d24e164a3672b92617be3e 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 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/mkdocs.yml b/mkdocs.yml index e1147cbc4137c05996afdc205c6a9924d4341f30..9415c0a907fc1bfbb9e3179f523679b7f64240d3 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