diff --git a/docs/easycozy/scripts.md b/docs/easycozy/scripts.md index b8388bfcd4918a02f0dc30faf32d380a4ff1b85b..0b45dd323aed7fe2f76fa0dabcff079f83bf2d39 100644 --- a/docs/easycozy/scripts.md +++ b/docs/easycozy/scripts.md @@ -1,32 +1,32 @@ # Easy Cozy scripts -Easy cozy project comes with 2 main scripts: +Easy cozy project comes with 2 main scripts: - create-instance.sh: used to create an instance for a user - remove-instance.sh: used to remove an instance for a specific user In addition of these scripts we have added custom scripts for some specific needs. All these scripts are available in the "admin_scripts" folder -# Scripts for instances +## Scripts for instances | Scripts | Args | Description | |-------------------|-------------------|----------------------------------------------------------| -| reset_instance.sh | instance_url | Remove and recreate again the instance for a given user | +| reset_instance.sh | instance_username | Remove and recreate again the instance for a given user | -# Scripts for applications +## Scripts for applications | Scripts | Args | Description | |--------------------------|-------------------|-------------------------------------------------------------------------------| | update_all_ecolyo_dev.sh | none | update Ecolyo with last version from build-dev branch on all instances | -| update_ecolyo_master.sh | instance_url | update Ecolyo with last version from build branch on a specific instance | -| update_ecolyo_dev.sh | instance_url | update Ecolyo with last version from build-dev branch on a specific instance | -| update_ecolyo_test.sh | instance_url | update Ecolyo with last version from build-test branch on a specific instance | -| update_pilote_master.sh | instance_url | update Pilote with last version from build-dev branch on a specific instance | -| update_pilote_dev.sh | instance_url | update PIlote with last version from build-test branch on a specific instance | +| update_ecolyo_master.sh | instance_username | update Ecolyo with last version from build branch on a specific instance | +| update_ecolyo_dev.sh | instance_username | update Ecolyo with last version from build-dev branch on a specific instance | +| update_ecolyo_test.sh | instance_username | update Ecolyo with last version from build-test branch on a specific instance | +| update_pilote_master.sh | instance_username | update Pilote with last version from build-dev branch on a specific instance | +| update_pilote_dev.sh | instance_username | update PIlote with last version from build-test branch on a specific instance | -# Scripts for konnectors +## Scripts for konnectors | Scripts | Args | Description | |---------------------------------|-------------------|----------------------------------------------------------------------------------------| -| update_enedis_konnector_prod.sh | instance_url | update Enedis konnector with last version from build branch on a specific instance | -| update_enedis_konnector_dev.sh | instance_url | update Enedis konnector with last version from build-dev branch on a specific instance | +| update_enedis_konnector_prod.sh | instance_username | update Enedis konnector with last version from build branch on a specific instance | +| update_enedis_konnector_dev.sh | instance_username | update Enedis konnector with last version from build-dev branch on a specific instance | diff --git a/docs/ecolyo/konnectors/egl.md b/docs/konnectors/egl.md similarity index 100% rename from docs/ecolyo/konnectors/egl.md rename to docs/konnectors/egl.md diff --git a/docs/ecolyo/konnectors/enedis.md b/docs/konnectors/enedis.md similarity index 100% rename from docs/ecolyo/konnectors/enedis.md rename to docs/konnectors/enedis.md diff --git a/docs/ecolyo/konnectors/grdf.md b/docs/konnectors/grdf.md similarity index 100% rename from docs/ecolyo/konnectors/grdf.md rename to docs/konnectors/grdf.md diff --git a/mkdocs.yml b/mkdocs.yml index 3a3a1a51b651b22f562468af578f58c4d3c626ce..f6441359a97fb88df165d5285ced19901f0bdca3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,94 +5,93 @@ repo_name: "Clone the Project" repo_url: "https://forge.grandlyon.com/web-et-numerique/llle_project/self-data-technical-doc" theme: - name: "material" - # logo: 'img/self_data_grdlyon.png' - favicon: "img/self_data_grdlyon.png" - palette: - primary: "white" - accent: "red" + name: "material" + # logo: 'img/self_data_grdlyon.png' + favicon: "img/self_data_grdlyon.png" + palette: + primary: "white" + accent: "red" markdown_extensions: - - admonition - - plantuml_markdown: - server: http://www.plantuml.com/plantuml - - attr_list - - pymdownx.emoji + - admonition + - plantuml_markdown: + server: http://www.plantuml.com/plantuml + - attr_list + - pymdownx.emoji extra_css: - - "stylesheets/extra.css" + - "stylesheets/extra.css" nav: - - Home: index.md - - Easy Cozy: - - Scripts: easycozy/scripts.md - - Commands: easycozy/commands.md - - Pilote: - - Pilote - TS - Back: - - Index: pilote/Pilote - TS - Back/index.md - - Application: - - Deploy: pilote/Pilote - TS - Back/application/deploy.md - - Functionalities: - - Routes: pilote/Pilote - TS - Back/functionalities/routes.md - - Getting Started: - - Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md - - Setup your environment: pilote/Pilote - TS - Back/getting_started/setup_your_environment.md - - Project Architecture: pilote/Pilote - TS - Back/project_architecture/architecture.md - - Pilote - TS - Front: - - Index: pilote/Pilote - TS - Front/index.md - - Application: - - Deploy: pilote/Pilote - TS - Front/application/deploy.md - - Functionalities: - - Routes: pilote/Pilote - TS - Front/functionalities/functions.md - - Getting Started: - - Launch the application on local: pilote/Pilote - TS - Front/getting_started/launch_local_application.md - - Pilote - Usager: - - Application: - - Deploy: pilote/Pilote - Usager/application/deploy.md - - Doctypes: pilote/Pilote - Usager/application/doctypes.md - - Gitflow: pilote/Pilote - Usager/application/gitflow.md - - Scaffolding: pilote/Pilote - Usager/application/scaffolding.md - - Services: pilote/Pilote - Usager/application/services.md - - Store: pilote/Pilote - Usager/application/store.md - - Functionalities: - - Appointments: pilote/Pilote - Usager/functionalities/appointments.md - - Contact: pilote/Pilote - Usager/functionalities/contact.md - - Document: pilote/Pilote - Usager/functionalities/document.md - - Settings: pilote/Pilote - Usager/functionalities/setting.md - - Getting Started: - - Launch local doctypes: pilote/Pilote - Usager/getting_started/launch_local_doctypes.md - - Launch local services: pilote/Pilote - Usager/getting_started/launch_local_services.md - - Ecolyo: - - Introduction: ecolyo/index.md - - Getting started: - - Setup your environment: ecolyo/getting_started/setup_your_environment.md - - Launch the application on local: ecolyo/getting_started/launch_local_application.md - - Launch a konnector on local: ecolyo/getting_started/launch_local_konnector.md - - Project Architecture: - - Architecture: ecolyo/project_architecture/architecture.md - - Cozy: ecolyo/project_architecture/cozy.md - - Environments: ecolyo/project_architecture/environments.md - - DocTypes: ecolyo/project_architecture/doctypes.md - - Application: - - Description: ecolyo/application/description.md - - Scaffolding: ecolyo/application/scaffolding.md - - Services: ecolyo/application/services.md - - Gitflow: ecolyo/application/gitflow.md - - Deploy: ecolyo/application/deploy.md - - Konnectors: - - Enedis: ecolyo/konnectors/enedis.md - - GRDF: ecolyo/konnectors/grdf.md - - Eau du Grand Lyon: ecolyo/konnectors/egl.md - - Functionalities: - - Initialization: ecolyo/functionalities/initialization.md - - Consumption: ecolyo/functionalities/consumption.md - - Ecogesture: ecolyo/functionalities/ecogesture.md - - Challenge: ecolyo/functionalities/challenge.md - - Analysis: ecolyo/functionalities/analysis.md - - Profile Type: ecolyo/functionalities/profile_type.md - - Proxy: - - Description: proxy/description.md - - Monitoring: proxy/monitoring.md - - Use cases: - - Enedis: proxy/use_cases/enedis.md - - Grdf Adict: proxy/use_cases/grdfadict.md + - Home: index.md + - Easy Cozy: + - Scripts: easycozy/scripts.md + - Commands: easycozy/commands.md + - Ecolyo: + - Introduction: ecolyo/index.md + - Getting started: + - Setup your environment: ecolyo/getting_started/setup_your_environment.md + - Launch the application on local: ecolyo/getting_started/launch_local_application.md + - Launch a konnector on local: ecolyo/getting_started/launch_local_konnector.md + - Project Architecture: + - Architecture: ecolyo/project_architecture/architecture.md + - Cozy: ecolyo/project_architecture/cozy.md + - Environments: ecolyo/project_architecture/environments.md + - DocTypes: ecolyo/project_architecture/doctypes.md + - Application: + - Description: ecolyo/application/description.md + - Scaffolding: ecolyo/application/scaffolding.md + - Services: ecolyo/application/services.md + - Gitflow: ecolyo/application/gitflow.md + - Deploy: ecolyo/application/deploy.md + - Functionalities: + - Initialization: ecolyo/functionalities/initialization.md + - Consumption: ecolyo/functionalities/consumption.md + - Ecogesture: ecolyo/functionalities/ecogesture.md + - Challenge: ecolyo/functionalities/challenge.md + - Profile Type: ecolyo/functionalities/profile_type.md + - Pilote: + - Pilote - TS - Back: + - Index: pilote/Pilote - TS - Back/index.md + - Application: + - Deploy: pilote/Pilote - TS - Back/application/deploy.md + - Functionalities: + - Routes: pilote/Pilote - TS - Back/functionalities/routes.md + - Getting Started: + - Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md + - Setup your environment: pilote/Pilote - TS - Back/getting_started/setup_your_environment.md + - Project Architecture: pilote/Pilote - TS - Back/project_architecture/architecture.md + - Pilote - TS - Front: + - Index: pilote/Pilote - TS - Front/index.md + - Application: + - Deploy: pilote/Pilote - TS - Front/application/deploy.md + - Functionalities: + - Routes: pilote/Pilote - TS - Front/functionalities/functions.md + - Getting Started: + - Launch the application on local: pilote/Pilote - TS - Front/getting_started/launch_local_application.md + - Pilote - Usager: + - Application: + - Deploy: pilote/Pilote - Usager/application/deploy.md + - Doctypes: pilote/Pilote - Usager/application/doctypes.md + - Gitflow: pilote/Pilote - Usager/application/gitflow.md + - Scaffolding: pilote/Pilote - Usager/application/scaffolding.md + - Services: pilote/Pilote - Usager/application/services.md + - Store: pilote/Pilote - Usager/application/store.md + - Functionalities: + - Appointments: pilote/Pilote - Usager/functionalities/appointments.md + - Contact: pilote/Pilote - Usager/functionalities/contact.md + - Document: pilote/Pilote - Usager/functionalities/document.md + - Settings: pilote/Pilote - Usager/functionalities/setting.md + - Getting Started: + - Launch local doctypes: pilote/Pilote - Usager/getting_started/launch_local_doctypes.md + - Launch local services: pilote/Pilote - Usager/getting_started/launch_local_services.md + - Konnectors: + - Enedis: konnectors/enedis.md + - GRDF: konnectors/grdf.md + - Eau du Grand Lyon: konnectors/egl.md + - Proxy: + - Description: proxy/description.md + - Monitoring: proxy/monitoring.md + - Use cases: + - Enedis: proxy/use_cases/enedis.md + - Grdf Adict: proxy/use_cases/grdfadict.md