diff --git a/README.md b/README.md index fed800e21f010ccc20e383f699de091056f313fb..8400e586eb0c5324c3026f2323078455d8c0f45d 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ - Gitflow: ecolyo/application/gitflow.md - Deploy: ecolyo/application/deploy.md - Konnectors: + - Introduction: ecolyo/konnectors/index.md - Enedis: ecolyo/konnectors/enedis.md - GRDF: ecolyo/konnectors/grdf.md - Eau du Grand Lyon: ecolyo/konnectors/egl.md diff --git a/docs/konnectors/index.md b/docs/konnectors/index.md new file mode 100644 index 0000000000000000000000000000000000000000..796b6409c1ffd464210aae9d19ea505495473cb4 --- /dev/null +++ b/docs/konnectors/index.md @@ -0,0 +1,13 @@ +Konnectors are scripts that import data from a web service and put those data into cozy. Each konnector is an independant application managed by the cozy home application. + +Ecolyo uses data from 3 web services : + +- Enedis +- Grdf +- Eau du grand lyon (EGL) + +All the konnectors are configured to retrieve user's data as far as 3 years back. +Some variation have to be considered : + +- When the user launches the konnector manually, it fetches 1 year of data (in order to reduce running time). +- When a konnector is launched by the cozy stack (at a random time between 10am and 11am), it fetches 3 years of data. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 6599ccdd40dfbe95e175d26114535317757ea5fd..92a864349f8a1fe44ecb0c054d165601e9d7bd40 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -98,6 +98,7 @@ nav: - 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: + - Introduction: konnectors/index.md - Enedis: konnectors/enedis.md - GRDF: konnectors/grdf.md - Eau du Grand Lyon: konnectors/egl.md