diff --git a/build/dictionary/mkdocs.dic b/build/dictionary/mkdocs.dic index 786b945341bf0d50f860e13a4540bb3fa388f502..05ede270f7786a42a9e330eed9535296a4789004 100644 Binary files a/build/dictionary/mkdocs.dic and b/build/dictionary/mkdocs.dic differ diff --git a/docs/cozystack/local.md b/docs/cozystack/local.md index 3452200fe8f94b9bf1fdb7f610da7b978db2cb9a..2c5df0efd3a0fa71b630b96f2a34ed2739f1d1b0 100644 --- a/docs/cozystack/local.md +++ b/docs/cozystack/local.md @@ -25,4 +25,4 @@ If we want to build a new stack version it's easy ! A manual pipeline has been c  -The image will be automaticaly build based on the branch and store in the registry. +The image will be automatically build based on the branch and store in the registry. diff --git a/docs/ecolyo/functionalities/consumption.md b/docs/ecolyo/functionalities/consumption.md index f0a24b16cd0d58298d0ed20ffadaa20d14f09dd2..4c307f27341083abdf104479cf146695afc15d41 100644 --- a/docs/ecolyo/functionalities/consumption.md +++ b/docs/ecolyo/functionalities/consumption.md @@ -32,7 +32,7 @@ For EGL, the interval is **5 days** ### Description -This view is the main view of the application. It displays an agreggation view of all connected fluids. +This view is the main view of the application. It displays an aggregation view of all connected fluids. It is the entrypoint to several children components that each handles a particular feature : - DateNavigator @@ -83,7 +83,7 @@ The component allows the user to navigate through the different fluid views (mul This component is the one that shows the user its consumption, according to the selected fluid, timestep and date. It is split in 3 distinct parts: -- The ConsumptionVisualier +- The ConsumptionVisualizer - The FluidSlides - The TimeStep Navigator diff --git a/docs/ecolyo/functionalities/dacc.md b/docs/ecolyo/functionalities/dacc.md index bbc43dff783e33e36e938de19c8b5c303698f0c2..929169c45a759e6e2d96b996370fbc0d150adf7c 100644 --- a/docs/ecolyo/functionalities/dacc.md +++ b/docs/ecolyo/functionalities/dacc.md @@ -195,7 +195,7 @@ node srcipts/server.js - Generate usage events by navigating through the app -You will be able to see previous events and freshly genereated events in the db `com-grandlyon-ecolyo-usageevent` +You will be able to see previous events and freshly generated events in the db `com-grandlyon-ecolyo-usageevent` :warning: because the cron run every day at 2am, it will take events from the day before. So if you want to test specific usage, you will have to edit the `eventDate` of events you want to send. diff --git a/docs/ecolyo/getting_started/launch_local_application.md b/docs/ecolyo/getting_started/launch_local_application.md index 8e846a96378ca73786b3cd5bf8af41062ac1f106..ab7297ee329da0fe2b267148303ac1247243d7ff 100644 --- a/docs/ecolyo/getting_started/launch_local_application.md +++ b/docs/ecolyo/getting_started/launch_local_application.md @@ -43,6 +43,13 @@ Launch the stack with the following command: docker-compose up ``` +If you have an access denied issue, try to docker login + +``` +docker login registry.forge.grandlyon.com +``` + + A Powershell window will open. Wait until the success message: > Everything is setup. Go to http://ecolyo.cozy.tools:8080/ @@ -55,7 +62,7 @@ Local database can also be consulted at the following url: [Cozy local DB](http: ## Use local konnectors In most case you will use mocked konnectors with mock data, but for some testing goals you will need real accounts. -In local, it is possible to run EGL en SGE-Enedis konnectors, with real accounts, but it needs somme specific manipulation as well as you'll need to use api secrets that are, of course, basically not available in the project. If you need to use konnectors with real accounts in testing goals, please follow the following steps. Otherwise, refer to the next two sections 'Import Mock Data' et 'Simulate konnector connexions'. +In local, it is possible to run EGL en SGE-Enedis konnectors, with real accounts, but it needs some specific manipulation as well as you'll need to use api secrets that are, of course, basically not available in the project. If you need to use konnectors with real accounts in testing goals, please follow the following steps. Otherwise, refer to the next two sections 'Import Mock Data' et 'Simulate konnector connections'. First step, make sure your stack is running. Then open your [couchDB](http://localhost:5984/_utils/) and look for the ```secrets/io-cozy-account_types``` entry. Then add a new document like this : @@ -89,7 +96,7 @@ SGE Enedis example !!! info "" You'll need to use konnector slug as is to make it work properly -You can contact an administrator in order to get the proper informations to fill in your secret. +You can contact an administrator in order to get the proper information to fill in your secret. Once it is done, you will be able to use these 2 Konnectors with real accounts. !!! warning "You might see this message before trying to log with SGE Account" diff --git a/docs/konnectors/enedis-sge.md b/docs/konnectors/enedis-sge.md index 6b79437424e9af23b5bfb09522963e636b2948db..2ecec7ba5608acd968833fa7220b3ddccf0bed21 100644 --- a/docs/konnectors/enedis-sge.md +++ b/docs/konnectors/enedis-sge.md @@ -27,9 +27,9 @@ For now enedis API are proxied by WSO2 api manager. You can find documentation a - core/types: contains jsdoc types - core/: requests wrapper with error handling logic - helpers/ : contains helpers for aggregation, env and parsing -- requests/: contain all methods for : Parsing sge requests, Send/get backoffice data, interacte with cozy stack +- requests/: contain all methods for : Parsing sge requests, Send/get backoffice data, interactions with cozy stack - index.js: main file where default konnector methods are launch (start, ...) -- onDeleteAccount.js: hold consent suppresion when a user delete an account. Automatically launched on delete. +- onDeleteAccount.js: hold consent suppression when a user delete an account. Automatically launched on delete. ### ts-check In order to have better comfort while coding, we have enable ts-checking with vs-code. The verification is based on js-doc, please take time to maintain the js-doc. @@ -61,7 +61,7 @@ In order to local test you have to put the following configuration in `konnector } ``` -Replace every `<***>` with yout test values and corresponding secrets. +Replace every `<***>` with your test values and corresponding secrets. !!! warning "user consent" While running in dev mode, be sure to have user consent, either on production env or with enedis standard form. @@ -75,7 +75,7 @@ yarn onDeleteAccount:standalone #Run onDeleteAccount script yarn onDeleteAccount #Run onDeleteAccount script with real cozy ``` -For standalone cmd you can find konnector resulte in `/data/importedData.json` +For standalone cmd you can find konnector results in `/data/importedData.json` ### Konnector Methods | Method | Description | @@ -89,13 +89,13 @@ For standalone cmd you can find konnector resulte in `/data/importedData.json` | setStartDate | Save startDate with the right time range | | storeData | Save data to user's cozy | | agregateMonthAndYearData | Sum daily data for months and years | -| isFirstStart | Check if it's first start or an alternate starte base on boId in cozy.account | +| isFirstStart | Check if it's first start or an alternate start base on boId in cozy.account | ## Dataflow ### Overview -Fonctionnal and technichal flow chart: +Functional and technical flow chart: [Lien du schema](https://whimsical.com/sge-tech-DxbYM8DdajRjTr6WZat1bV) @@ -362,7 +362,7 @@ Data Route : **enedis_SGE_ConsultationDonneesTechniquesContractuelles/1.0** #### Contract deletion and creation on same day -If you stop a contract on a day, (for exemple 8/08/22), you cannot start a new contract for this date with [start contract route](#user_contract_start). You have to wait for the next day. This might cause somme production issues +If you stop a contract on a day, (for exemple 8/08/22), you cannot start a new contract for this date with [start contract route](#user_contract_start). You have to wait for the next day. This might cause some production issues #### User data collect opposition diff --git a/docs/pilote/Pilote - TS - Back/functionalities/routes.md b/docs/pilote/Pilote - TS - Back/functionalities/routes.md index 3a5488e5eefb705ab1ecaa1ee766f574e18c9e73..b338be641207e070637fc1f8498069c046e555a0 100644 --- a/docs/pilote/Pilote - TS - Back/functionalities/routes.md +++ b/docs/pilote/Pilote - TS - Back/functionalities/routes.md @@ -23,7 +23,7 @@ A swagger documentation can be consulted at [http://localhost:3000/api/doc/](htt - `/api/beneficiaire/create'`: This route is used in order to store Usager domain and his trigger process 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 route is used in order to remove Usager domain and his trigger process. 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. +- `/api/beneficiaire/remove'`: This route is used in order to remove Usager domain and his trigger process. Only available 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 beneficiary by Postman - Create a POST request diff --git a/docs/src/dictionary/en-custom.txt b/docs/src/dictionary/en-custom.txt index 75b73dfa068f9aa7d68da35cc8c26669d26f236a..17ab0bd6f7f4fdb87c7a77a496df1dd88fa942dc 100644 --- a/docs/src/dictionary/en-custom.txt +++ b/docs/src/dictionary/en-custom.txt @@ -61,25 +61,43 @@ NestJs Oauth OAuth Pilote +anonymised +developpement +existant +importData +repo Usager +UploadDocument PDL +CONSOS PNGs +subType +devtools +Postgre +concat PNG Powershell Ressources README SMS +Recette +sge +fetchJSON SGE +ConsultationMesuresDetaillees SVG SVGs TabOut TaskItem TaskItems Téléo +CommandeCollectePublicationMesures +RechercheServicesMesures TypeAgregats Typescript Ui UI +UUID YYYY ValeurIndex WSL @@ -124,6 +142,7 @@ duelEntity fluidType couchDB dataEntity +jsdoc userData userDataName fluidtype @@ -369,15 +388,21 @@ mesureName lastDataDate FluidForecast VM +OTP MonthlyForecast +blackbox dropdown mailData createDayDataFiles sendEmail DataloadNoValue +checkboxes +aggregatorUsageEvents AnalysisConsumptionRow +sandboxed GCU isWelcomeSeen +Equipments createConnection HasMany FluidButtons