diff --git a/docs/easycozy/commands.md b/docs/easycozy/commands.md
index 3e4bc3c0311e3934f9f61c71dfcaeba7eadb1218..ac3da7766bacfc5360f171366cdd92e783e5b084 100644
--- a/docs/easycozy/commands.md
+++ b/docs/easycozy/commands.md
@@ -1,17 +1,19 @@
-Here are common commands use on dev environment.
+# Easy Cozy commands
-# App
+This section includes all common commands used on dev environment.
-## Install a specific version of an app
+## App
+
+### Install a specific version of an app
```bash
$ cd /easy-cozy
$ docker-compose exec cozy ./cozy apps update home --domain "[name].cozy.self-data.alpha.grandlyon.com" git://github.com/doubleface/cozy-collect.git#build-debug
```
-# Konnector
+## Konnector
-## Install a specific version of a konnector
+### Install a specific version of a konnector
```bash
$ cd /easy-cozy
@@ -23,7 +25,7 @@ $ docker-compose exec cozy ./cozy konnectors install grdfgrandlyon --domain "[na
grdfgrandlyon (0.1.5-a3f6f05d9fde7c705b811658b3ce3667a9d7d0b5) has been installed on [name].cozy.self-data.alpha.grandlyon.com
```
-## Update the version of a konnector
+### Update the version of a konnector
```bash
$ cd /easy-cozy
@@ -31,7 +33,7 @@ $ cd /easy-cozy
$ docker-compose exec cozy ./cozy konnectors update grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com"
grdfgrandlyon has been upgraded to 0.1.5-d4bbe7350ecf13d13734f559c538e3c0ee8dc7ae
```
-## Run a konnector from the stack
+### Run a konnector from the stack
```bash
$ cd /root/easy-cozy
@@ -39,9 +41,9 @@ $ cd /root/easy-cozy
$ docker-compose exec cozy ./cozy konnectors run grdfgrandlyon --domain "[name].cozy.self-data.alpha.grandlyon.com"
```
-# Instance
+## Instance
-## Set log level to debug for an instance
+### Set log level to debug for an instance
```bash
$ cd /root/easy-cozy
@@ -50,16 +52,16 @@ $ docker-compose exec cozy ./cozy instances debug --domain "[name].cozy.self-dat
```
-# Stack
+## Stack
-## Check stack version
+### Check stack version
```bash
$ cd /easy-cozy
$ docker-compose exec cozy ./cozy version
```
-## Update stack version
+### Update stack version
Update version in the Dockerfile on gitlab.
@@ -83,4 +85,5 @@ Update version in the Dockerfile on gitlab.
!!! info "Error encounter"
Docker container was not launched, when consulting logs we can see the folowing error
> ./cozy: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.32' not found (required by ./cozy)
+
We have replaced debian:stable-slim with unbuntu:20.10 as installer for our docker build: [https://forge.grandlyon.com/pocs/cozy/easy-cozy/-/commit/48a30a03f209169e0f1ebb0d106bb4361e7cd167](https://forge.grandlyon.com/pocs/cozy/easy-cozy/-/commit/48a30a03f209169e0f1ebb0d106bb4361e7cd167)
diff --git a/docs/easycozy/scripts.md b/docs/easycozy/scripts.md
index b8388bfcd4918a02f0dc30faf32d380a4ff1b85b..91766c9b973179cb552a8cceaf41e8d3fabafae7 100644
--- a/docs/easycozy/scripts.md
+++ b/docs/easycozy/scripts.md
@@ -1,32 +1,33 @@
# 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/functionalities/challenge.md b/docs/ecolyo/functionalities/challenge.md
index 90930bed2c55b46b566d65a421b25ebded18f4ff..b3037fcc260171cdb3bd9334522421e7826ed028 100644
--- a/docs/ecolyo/functionalities/challenge.md
+++ b/docs/ecolyo/functionalities/challenge.md
@@ -4,6 +4,21 @@ This section explain all the functionnalities in the challenge part
A quiz includes 4 basic questions and one custom question.
+### Process
+
+Questions and answers are generated in random order.
+
+At the begining of the quiz, the user have to select an answer and click validate.
+
+Then, he sees the right answer and a modal with the explanation. After this modal, he goes to the next question.
+
+Depending on the answer, the question result state is set either to correct or incorrect.
+If it is a right answer, the quiz result is incremented by one.
+
+A user can stop during a quiz and picks up where he left off. To define where the user left off, we have to check if at least one of the question result status is unlocked.
+
+Once the custom question is answered, the quiz state is set to done. Then, the user sees his result and his earned stars. He can also retry or go back to the challenge page.
+
### Basic Question
All basics Questions are created in the quizEntity.json. We have to add :
@@ -15,15 +30,6 @@ All basics Questions are created in the quizEntity.json. We have to add :
| description | Explains the question |
| source | Source of the explanation |
-This questions and answers are in random order.
-
-In the question page the user have to select an answer and click validate.
-
-Then, he sees the right answer and a modal with the explanation and the source. After this modal, he goes to the next question.
-
-Depending on the answer, the question result state is set either to correct or incorrect.
-If it is a right answer, the quiz result is incremented by one.
-
### Custom Question
At the end of every quiz, we're creating a custom question.
@@ -38,7 +44,7 @@ Here are the fields used to create a custom question
| singleFluid | boolean | Indicate if all connected fluid should be taken into account.<br/>If set to true only the first connected fluid will be taken into account in this order: electricity, gas, water. #unit and #fluid in the question label will be replace by the unit and the name of the fluid |
| result | UserQuizState | Indicate the state of the custom question (UNLOCKED, CORRECT, UNCORRECT) |
-Calculation of custom question is done by conbinaison of all parameters:
+Calculation of custom question is done by combination of all parameters:
#### Type DATE
@@ -46,36 +52,36 @@ Calculation of custom question is done by conbinaison of all parameters:
Retrieve the **date** of day/month/year (define by _timeStep_) from the last week, month, year (define by _interval_).
- ```
- example: What day did I consumme the most on the last week ?
- type = CustomQuestionType.DATA
- timeStep = TimeStep.DAY
- interval = TimeStep.WEEK
- period = {}
- singleFluid = false
- ```
-
- ```
- example: What day did I consumme the most #fluid in #unit on the last week ?
- type = CustomQuestionType.DATA
- timeStep = TimeStep.DAY
- interval = TimeStep.WEEK
- period = {}
- singleFluid = true
- ```
+```
+example: What day did I consumme the most on the last week ?
+type = CustomQuestionType.DATA
+timeStep = TimeStep.DAY
+interval = TimeStep.WEEK
+period = {}
+singleFluid = false
+```
+
+```
+example: What day did I consumme the most #fluid in #unit on the last week ?
+type = CustomQuestionType.DATA
+timeStep = TimeStep.DAY
+interval = TimeStep.WEEK
+period = {}
+singleFluid = true
+```
- If _period_ is not empty
Retrieve the **date** of day/month/year (define by _timeStep_) from a week, month, year (define by _interval_) of _period_
- ```
- example: What month did I consumme the most on year 2020 ?
- type = CustomQuestionType.DATA
- timeStep = TimeStep.MONTH
- interval = TimeStep.YEAR
- period = { year: 2020 }
- singleFluid = false
- ```
+```
+example: What month did I consumme the most on year 2020 ?
+type = CustomQuestionType.DATA
+timeStep = TimeStep.MONTH
+interval = TimeStep.YEAR
+period = { year: 2020 }
+singleFluid = false
+```
#### Type MAXLOAD
@@ -109,48 +115,55 @@ singleFluid = false
- If _period_ is empty
- Retrieve the **average** of day/month/year (define by _timeStep_) from the last week, month, year (define by _interval_).
+Retrieve the **average** of day/month/year (define by _timeStep_) from the last week, month, year (define by _interval_).
- ```
- example: Which is your daily average consumption on last week ?
- type = CustomQuestionType.AVERAGE
- timeStep = TimeStep.DAY
- interval = TimeStep.WEEK
- period = {}
- singleFluid = false
- ```
+```
+example: Which is your daily average consumption on last week ?
+type = CustomQuestionType.AVERAGE
+timeStep = TimeStep.DAY
+interval = TimeStep.WEEK
+period = {}
+singleFluid = false
+```
- - If _period_ is not empty
+- If _period_ is not empty
- Retrieve the **average** of day/month/year (define by _timeStep_) from a week, month, year (define by _interval_) of _period_
+Retrieve the **average** of day/month/year (define by _timeStep_) from a week, month, year (define by _interval_) of _period_
- ```
- example: Which is your daily average consumption on january 2020 ?
- type = CustomQuestionType.AVERAGE
- timeStep = TimeStep.DAY
- interval = TimeStep.MONTH
- period = { month: 1, year: 2020 }
- singleFluid = false
- ```
+```
+example: Which is your daily average consumption on january 2020 ?
+type = CustomQuestionType.AVERAGE
+timeStep = TimeStep.DAY
+interval = TimeStep.MONTH
+period = { month: 1, year: 2020 }
+singleFluid = false
+```
- - If _period_ is weekday
+- If _period_ is weekday
- Retrieve the **average** of the _weekday_ from a week, month, year (define by _interval_).
+Retrieve the **average** of the _weekday_ from a week, month, year (define by _interval_).
- ```
- example: Which is your daily average consumption on wednesdays of last month?
- type = CustomQuestionType.AVERAGE
- timeStep = TimeStep.DAY
- interval = TimeStep.MONTH
- period = { weekday: 3 }
- singleFluid = false
- ```
+```
+example: Which is your daily average consumption on wednesdays of last month?
+type = CustomQuestionType.AVERAGE
+timeStep = TimeStep.DAY
+interval = TimeStep.MONTH
+period = { weekday: 3 }
+singleFluid = false
+```
-Then, two randoms answers are generated after defining the right answer.
+#### Wrong answers
-A user can stop during a quiz and picks up where he left off. To define where the user left off, we have to check if at least one of the question result status is unlocked.
+After defining the right answer, two randows answers are generated depending of the custom question type:
-Once the custom question is answered, the quiz state is set to done. Then, the user sees his result and his earned stars. He can also retry or go back to the challenge page.
+- type DATE
+
+Two dates is generated one, a day before the correct date and the other, a day after.
+
+- type MAXLOAD or AVERAGE
+
+Two random value is generated by applying a coefficient based on the correct answer.
+This coefficient is randomly included between 0.7 and 0.9 (for the first value) or between 1.1 and 1.3 (for the second value)
## Exploration
diff --git a/docs/ecolyo/project_architecture/architecture.md b/docs/ecolyo/project_architecture/architecture.md
index 26f2105bdccaf37c202519169b1d4bf3c8336fc3..8943d8a1544e8a66a0cbcc7e61f3cd1eff3d0372 100644
--- a/docs/ecolyo/project_architecture/architecture.md
+++ b/docs/ecolyo/project_architecture/architecture.md
@@ -1,84 +1,7 @@
-## Libraries
+# Architecture
-For this project, we use the libraries below:
+## Principle diagram
-###React
+The principle diagram below describes the responsibilities of each application brick.
-Library to create user interfaces.
-Design simple views for each state in your application, and React will efficiently update and render just the right components when your data changes.
-
-Build encapsulated components that manage their own state, then compose them to make complex UIs.
-
-Since component logic is written in JavaScript instead of templates, you can easily pass rich data through your app and keep state out of the DOM
-
-###React Redux
-
-It is a predictable state container.
-
-It is implemented for a better management of the states because it allows to centralize all the states and the logic of the application.
-It lets a react component read data from a Redux store, and dispatch actions to the store to update data.
-
-###Axios
-
-HTTP client library
-
-It allows to send HTTP request and manage the responses.
-
-###Lodash
-
-javascript utility library
-
-Lodash'modular method are great for:
-
-- Iterating arrays, objects, & strings
-- Manipulating & testing values
-- Creating composite functions
-
-###Moment
-
-Date library to parse, validate, manipulate, and display dates and times in JavaScript.
-
-###Luxon
-
-Wrapper for Javascript dates and times.
-
-###Jest
-
-Testing library
-
-It allows to evaluate functionnalities of an app to ensure that the product is defect-free in order to produce the quality product.
-
-###Enzyme
-
-Testing utility for React
-
-It makes it easier to test your React Components' output. You can also manipulate, traverse, and in some ways simulate runtime given the output.
-
-###Sass
-
-CSS preprocessor
-
-It allows us to easily manage large CSS files and split across different files.
-It allows us to create variables, nested rules, mixins, functions, and do mathematical calculations.
-
-###Material UI
-
-It allows to create react component that implements Google's material design
-
-###D3
-
-It allows to manipulate documents based on data.
-It combines visualization components and a data-driven approach to DOM manipulation.
-
-###React-swipeable-views
-
-It is a React component to make swipeable views
-
-###React-lottie
-
-Lottie Animation View for React.
-It allows app to use animations easily.
-
-###Husky
-
-It is used to improve your commit.
+
diff --git a/docs/ecolyo/project_architecture/cozy.md b/docs/ecolyo/project_architecture/cozy.md
deleted file mode 100644
index 2f4f692dba5c6228a0130fccce621b4c7e2d7452..0000000000000000000000000000000000000000
--- a/docs/ecolyo/project_architecture/cozy.md
+++ /dev/null
@@ -1,2 +0,0 @@
-!!! info ""
- :construction: Section under Construction :construction:
\ No newline at end of file
diff --git a/docs/ecolyo/project_architecture/libraries.md b/docs/ecolyo/project_architecture/libraries.md
new file mode 100644
index 0000000000000000000000000000000000000000..227c6e9615e03088c8b3f95b345277decaee028f
--- /dev/null
+++ b/docs/ecolyo/project_architecture/libraries.md
@@ -0,0 +1,84 @@
+# Libraries
+
+For this project, we use the libraries below:
+
+## React
+
+Library to create user interfaces.
+Design simple views for each state in your application, and React will efficiently update and render just the right components when your data changes.
+
+Build encapsulated components that manage their own state, then compose them to make complex UIs.
+
+Since component logic is written in JavaScript instead of templates, you can easily pass rich data through your app and keep state out of the DOM
+
+## React Redux
+
+It is a predictable state container.
+
+It is implemented for a better management of the states because it allows to centralize all the states and the logic of the application.
+It lets a react component read data from a Redux store, and dispatch actions to the store to update data.
+
+## Axios
+
+HTTP client library
+
+It allows to send HTTP request and manage the responses.
+
+## Lodash
+
+javascript utility library
+
+Lodash'modular method are great for:
+
+- Iterating arrays, objects, & strings
+- Manipulating & testing values
+- Creating composite functions
+
+## Moment
+
+Date library to parse, validate, manipulate, and display dates and times in JavaScript.
+
+## Luxon
+
+Wrapper for Javascript dates and times.
+
+## Jest
+
+Testing library
+
+It allows to evaluate functionnalities of an app to ensure that the product is defect-free in order to produce the quality product.
+
+## Enzyme
+
+Testing utility for React
+
+It makes it easier to test your React Components' output. You can also manipulate, traverse, and in some ways simulate runtime given the output.
+
+## Sass
+
+CSS preprocessor
+
+It allows us to easily manage large CSS files and split across different files.
+It allows us to create variables, nested rules, mixins, functions, and do mathematical calculations.
+
+## Material UI
+
+It allows to create react component that implements Google's material design
+
+## D3
+
+It allows to manipulate documents based on data.
+It combines visualization components and a data-driven approach to DOM manipulation.
+
+##React-swipeable-views
+
+It is a React component to make swipeable views
+
+## React-lottie
+
+Lottie Animation View for React.
+It allows app to use animations easily.
+
+## Husky
+
+It is used to improve your commit.
diff --git a/docs/img/architecture/cozy-architecture-principles.png b/docs/img/architecture/cozy-architecture-principles.png
new file mode 100644
index 0000000000000000000000000000000000000000..30b67b9cadc17cc4e223c4b9a63c5eef860b6420
Binary files /dev/null and b/docs/img/architecture/cozy-architecture-principles.png differ
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/docs/pilote/Pilote - TS - Back/application/deploy.md b/docs/pilote/Pilote - TS - Back/application/deploy.md
index cf41a3fd851a0b009feb93a1c2a54042225f5088..9b1701fe4f02cb62b84cf01624fd5ff94472d525 100644
--- a/docs/pilote/Pilote - TS - Back/application/deploy.md
+++ b/docs/pilote/Pilote - TS - Back/application/deploy.md
@@ -2,4 +2,6 @@
For each environment, the CI-CD is implemented.
-Once, you commit on 'dev' branch or 'rec' branch, the pipeline linked is running.
\ No newline at end of file
+Once, you commit on 'dev' branch or 'rec' branch, the pipeline linked is running.
+
+On master branch, only build is set on the pipeline.
\ No newline at end of file
diff --git a/docs/pilote/Pilote - TS - Back/functionalities/routes.md b/docs/pilote/Pilote - TS - Back/functionalities/routes.md
index ea55a4625a0a47a4bfad38d17507c0aac93e79cf..88aa70d29cd0a5c24684cb2a49a5f9ce7c0caf91 100644
--- a/docs/pilote/Pilote - TS - Back/functionalities/routes.md
+++ b/docs/pilote/Pilote - TS - Back/functionalities/routes.md
@@ -21,9 +21,21 @@ This section explains the different API route.
- `/api/beneficiaire`: Get all usager known from Postgre database.
-- `/api/beneficiaire/create'`: This rotue is used in order to store Usager domain and his trigger proccess from Cozy.
-
-
+- `/api/beneficiaire/create'`: This rotue is used in order to store Usager domain and his trigger proccess from Cozy. This route is protected by a COZY_SECRET env variable token. This token is generated by us. If you change it, you need to inform Cozy team because this token is store in their side also.
+
+- `/api/beneficiaire/remove'`: This rotue is used in order to remove Usager domain and his trigger proccess. Only availabe by POST. This route is not accessible from any part of TS FRONT application. Protected rout by the same token of create route.
+
+## Add one benificiary by Postman
+- Create a POST request
+- Entry the URL: http://localhost:3020/api/beneficiaire/create or https://pilote-agent-rec.grandlyon.com/api/beneficiaire/create
+- Push in Authorizathion/ Bearer Token => the token use by "process.env.COZY_SECRET"
+- In Body, as JSON format example :
+- ``
+{"cozy_name":"pilote-rec.cozy.self-data.alpha.grandlyon.com","trigger":"https://pilote-rec.cozy.self-data.alpha.grandlyon.com/jobs/webhooks/d010bf3fa2aed6f3c6584ea93a54affc"}
+``
+- Local : ``
+{"cozy_name":"mps.cozy.tools:8080","trigger":"http://mps.cozy.tools:8080/jobs/webhooks/"}
+``
# Cozy
diff --git a/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md b/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md
index 942de67200e15ff491bd8cc74fc95165b2319426..7efb6e23f91df92a42ab419cd5978b637997bd0b 100644
--- a/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md
+++ b/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md
@@ -37,3 +37,5 @@ To start test defined just run the command in a PowerShell or Windows Powershell
```
yarn test:watch
```
+
+Don't forget to uncomment ending row into beneficiary.service.ts file before to run the above command.
\ No newline at end of file
diff --git a/docs/pilote/Pilote - TS - Front/functionalities/functions.md b/docs/pilote/Pilote - TS - Front/functionalities/functions.md
index e48e62494a5db1449f25d16c2df11dc5d03c2f6e..71ca1f2d29d35eb21d36e55db87324826f2165da 100644
--- a/docs/pilote/Pilote - TS - Front/functionalities/functions.md
+++ b/docs/pilote/Pilote - TS - Front/functionalities/functions.md
@@ -8,4 +8,6 @@ You are getting all usager known.
# Sharing
-For each beneficiary, you can ask the sharing. It means that you will be redirect into the public page of the cozy usager. In the same time, one process is running in order to send the sms. This sms contain one sharecode in order to provide some right on the cozy usager.
\ No newline at end of file
+For each beneficiary, you can ask the sharing. It means that you will be redirect into the public page of the cozy usager. In the same time, one process is running in order to send the sms. This sms contain one sharecode in order to provide some right on the cozy usager.
+
+In order to help you to understand this process, you can check : Pilote - TS - Back/project_architecture/Partage_SMS.png
\ No newline at end of file
diff --git a/docs/pilote/Pilote - Usager/application/doctypes.md b/docs/pilote/Pilote - Usager/application/doctypes.md
index dcccd052477bfa11eb3e754c554bf3dc6d511a6e..9b25535d2d7bda94072d8498f6277b8a76efbf7a 100644
--- a/docs/pilote/Pilote - Usager/application/doctypes.md
+++ b/docs/pilote/Pilote - Usager/application/doctypes.md
@@ -16,10 +16,22 @@ The following is a full description of the doctypes we use and their fields. Coz
- [`io.cozy.files`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files): Files
- [`io.cozy.permissions`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.permissions): Permissions of the instance
- [`io.cozy.todos.item`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.item): Todos item
-- [`io.cozy.todos.list`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.list): Todos list
- [`io.cozy.triggers`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.triggers): Job triggers
+## Used Cozy remote doctypes
+This kind of doctype are set from the team. We have push two remote doctypes (each duplicate for rec and prod environment)
+> Prod
+- [`org.mps.store`]: Required for store information on back-endTS
+- [`org.mps.share`]: Required for searching on back-endTS
+
+> Recette
+
+- [`org.mps.store.rec`]: Required for store information on rec back-endTS
+- [`org.mps.share.rec`]: Required for searching on rec back-endTS
+
+If you need to target rec remote doctype, you need to change the request : client.getStackClient().fetchJSON('POST','...')
+and change them into the manifest also.
## Custom doctypes
diff --git a/docs/pilote/Pilote - Usager/functionalities/appointments.md b/docs/pilote/Pilote - Usager/functionalities/appointments.md
new file mode 100644
index 0000000000000000000000000000000000000000..19b7d0ae4bce4f3f511174746c2f6cf7550937a7
--- /dev/null
+++ b/docs/pilote/Pilote - Usager/functionalities/appointments.md
@@ -0,0 +1 @@
+This section explain all the functionnalities in the appointment part
diff --git a/docs/pilote/Pilote - Usager/functionalities/contact.md b/docs/pilote/Pilote - Usager/functionalities/contact.md
new file mode 100644
index 0000000000000000000000000000000000000000..781f465ceee84c8c1cf1f45a5d891020f03daa20
--- /dev/null
+++ b/docs/pilote/Pilote - Usager/functionalities/contact.md
@@ -0,0 +1,6 @@
+## Description
+
+Pilote allow usager to add contact :
+- You will always see your profil at the first contact. You can not delete it. Just edit it.
+- Then, with the add concat button, you can add others contact
+
diff --git a/docs/pilote/Pilote - Usager/functionalities/document.md b/docs/pilote/Pilote - Usager/functionalities/document.md
new file mode 100644
index 0000000000000000000000000000000000000000..ab86519de6beacaa5b43459e0bdf576be603a04c
--- /dev/null
+++ b/docs/pilote/Pilote - Usager/functionalities/document.md
@@ -0,0 +1 @@
+This section explains how to handle data storage.
diff --git a/docs/pilote/Pilote - Usager/functionalities/setting.md b/docs/pilote/Pilote - Usager/functionalities/setting.md
new file mode 100644
index 0000000000000000000000000000000000000000..2e733efc862de8d651335ac2be29cc9693db68fb
--- /dev/null
+++ b/docs/pilote/Pilote - Usager/functionalities/setting.md
@@ -0,0 +1,8 @@
+## Description
+
+Pilote has setting page. You can found :
+- Notifications: Under construction
+- Tutorial: allow to view again one of the tutorial available
+- FAQ: Different explication of the global application
+- Legal Notice
+
diff --git a/mkdocs.yml b/mkdocs.yml
index cf02ac924d31310ee3491e4ed057362faad9c735..8a682782d3df81277f1718e843f3767a00644bf4 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -5,89 +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
- - 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
+ - Libraries: ecolyo/project_architecture/libraries.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