diff --git a/docs/easycozy/commands.md b/docs/easycozy/commands.md index 5988bdca3d8fb7286685ecbe14f585632e84fe7d..6ebc8ea57b12c0e981d50220bd85c1a45e01bfaa 100644 --- a/docs/easycozy/commands.md +++ b/docs/easycozy/commands.md @@ -1,4 +1,4 @@ -# Easy Cozy commands +### :keyboard: Easy Cozy commands ### This section includes all common commands used on dev environment. diff --git a/docs/easycozy/config.md b/docs/easycozy/config.md index 8f2bf2ebda6c3713094786bc3053d629cf4ec20c..8c231aa9432370b64701ba7c5829909e1c2fb7e8 100644 --- a/docs/easycozy/config.md +++ b/docs/easycozy/config.md @@ -1,11 +1,11 @@ -# Easy Cozy configuration +### :gear: Configuration This section includes all configurations available for the stack. -## Configuration File +#### Configuration File The stack's configuration file is located at `.easy-cozy/cozystack/cozy.yml`. It can be edited in order to changes various parameters, smtp, logs ... -## SMTP +#### SMTP Modify the `cozy.yml` responsible for the configuration : diff --git a/docs/easycozy/index.md b/docs/easycozy/index.md new file mode 100644 index 0000000000000000000000000000000000000000..a41678780ac3ae88fec8400008c874e7858efcee --- /dev/null +++ b/docs/easycozy/index.md @@ -0,0 +1,6 @@ +### What is easy-cozy ? + +### What purpose does it serves to us ? + +### How we use it + diff --git a/docs/ecolyo/index.md b/docs/ecolyo/index.md index 2a44754ea564a35cca83636289c6fae9e819c02d..388f9980eb7da22a4e33bb4bcf85a6cb237d0ebe 100644 --- a/docs/ecolyo/index.md +++ b/docs/ecolyo/index.md @@ -1,9 +1,13 @@ +{: .center} + 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 [setup your environment](./getting_started/setup_your_environment.md) and [launch the application on local](./getting_started/launch_local_application.md) to start the application. -## Repository +##  Repositories -[Ecolyo gitlab repository](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo) \ No newline at end of file +- [ecolyo](https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo) +- [ecolyo-agent serveur](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server) +- [ecolyo-agent client](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client) \ No newline at end of file diff --git a/docs/img/ecolyo.png b/docs/img/ecolyo.png new file mode 100644 index 0000000000000000000000000000000000000000..605722e1048c7697f4355a646bb0f22edc8faa20 Binary files /dev/null and b/docs/img/ecolyo.png differ diff --git a/docs/img/flowgrdf.jpeg b/docs/img/flowgrdf.jpeg deleted file mode 100644 index 19eeea5ba967111c07ced2ec62ece0197feec0d5..0000000000000000000000000000000000000000 Binary files a/docs/img/flowgrdf.jpeg and /dev/null differ diff --git a/docs/img/gitlab-logo.svg b/docs/img/gitlab-logo.svg new file mode 100644 index 0000000000000000000000000000000000000000..9d0d717f92cd0d21f069cd8f4b4e4c28f05fac56 --- /dev/null +++ b/docs/img/gitlab-logo.svg @@ -0,0 +1 @@ +<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1.33334 9.33332 7.58668 15.3333V9.33332L4.92001 1.14666C4.78334.725325 4.13601.725325 4.00001 1.14666L1.33334 9.33332z" fill="#e24329"/><path d="M22.6667 9.33332 16.4133 15.3333V9.33332L19.08 1.14666C19.2167.725325 19.864.725325 20 1.14666L22.6667 9.33332z" fill="#e24329"/><path d="M12 22.92 2 9.33334H22L12 22.92z" fill="#e24329"/><path d="M12 22.92 7.58668 9.33334H1.33334L4.00001 16.6667 12 22.92z" fill="#fc6d26"/><path d="M12 22.92 16.4133 9.33334H22.6667L20 16.6667 12 22.92z" fill="#fc6d26"/><path d="M1.33333 9.33334.0666658 13.44C-.0533342 13.8167.0666659 14.24.399999 14.48L12.0133 22.92 1.33333 9.33334z" fill="#fca326"/><path d="M22.6667 9.33334 23.9333 13.44C24.0533 13.8167 23.9333 14.24 23.6 14.48L12 22.92 22.6667 9.33334z" fill="#fca326"/></svg> \ No newline at end of file diff --git a/docs/img/mps.png b/docs/img/mps.png new file mode 100644 index 0000000000000000000000000000000000000000..f6542ea902c71d9592f8fbea9bcfb14dd23186eb Binary files /dev/null and b/docs/img/mps.png differ diff --git a/docs/img/selfdata.png b/docs/img/selfdata.png new file mode 100644 index 0000000000000000000000000000000000000000..50226a8668417b8f488bb11698d26eac4996e7f2 Binary files /dev/null and b/docs/img/selfdata.png differ diff --git a/docs/index.md b/docs/index.md index 68fbaaa518dcf4d3846720785a4965b8e066d5df..0593c76d64cbb5b05b932cc288aa691bb2f0956c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,7 @@ -{: .center} +# +{: .center} -The self-data Grandlyon technical documentation covers projects developed by the Grandlyon in cooperation with [Cozy Cloud](https://cozy.io/fr/). +This documentation covers the technical aspects of projects developed by the Grandlyon in cooperation with [Cozy Cloud](https://cozy.io/fr/). {: .inline-center-left}  \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 4edbe1e517b91665b8ba617bacf17caa9d6529ab..d83f5fb1a128c093086b1232552408ab766c828a 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,8 +1,14 @@ .center { display: block; margin: auto; + margin-bottom: 10%; } .inline-center-left { float: right; } + +.md-typeset h1, +.md-content__button { + display: none; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index dff24b7b346347ec001f1f56dabfd697d0a89fb7..5f323141dab912636d9eff9d7357ae038ba17321 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,6 +25,7 @@ extra_css: nav: - Home: index.md - Easy Cozy: + - Introduction: easycozy/index.md - Configuration: easycozy/config.md - Commands: easycozy/commands.md - Known errors: easycozy/known_errors.md