From 34415e13cd76d89a72bce23923c9a1d8f251d1cb Mon Sep 17 00:00:00 2001
From: Hugo <hnouts@grandlyon.com>
Date: Tue, 13 Jul 2021 11:41:58 +0200
Subject: [PATCH] konnector intro
manual/auto execution
---
README.md | 1 +
docs/konnectors/index.md | 13 +++++++++++++
mkdocs.yml | 1 +
3 files changed, 15 insertions(+)
create mode 100644 docs/konnectors/index.md
diff --git a/README.md b/README.md
index fed800e..8400e58 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 0000000..796b640
--- /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 fab28c3..a57ce82 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -97,6 +97,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
--
GitLab