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/easycozy/config.md b/docs/easycozy/config.md new file mode 100644 index 0000000000000000000000000000000000000000..0a525cad7e8f16377ace179d4f7327f47f325c06 --- /dev/null +++ b/docs/easycozy/config.md @@ -0,0 +1,48 @@ +# Easy Cozy configuration + +This section includes all configurations available for the stack. + +## Configuration File + +The configuration file of the stack is located at `.easy-cozy/cozystack/cozy.yml`. It can be edit in order to changes various parameters, smtp, logs ... + +## SMTP + +### Install a specific version of an app + +Modif the `cozy.yml` responsible for the configuration : + +```yml +mail: + # mail noreply address - flags: --mail-noreply-address + noreply_address: noreply@localhost + noreply_name: My Cozy + reply_to: support@cozycloud.cc + # mail smtp host - flags: --mail-host + host: smtp.home + # mail smtp port - flags: --mail-port + port: 465 + # mail smtp username - flags: --mail-username + username: {{.Env.COZY_MAIL_USERNAME}} + # mail smtp password - flags: --mail-password + password: {{.Env.COZY_MAIL_PASSWORD}} + # disable mail tls - flags: --mail-disable-tls + disable_tls: false + # skip the certificate validation (may be useful on localhost) + skip_certificate_validation: false +``` + +According to cozy-stack issue: https://github.com/cozy/cozy-stack/issues/2009 you might need to change above configuration with : + +```yml +mail: + # mail smtp port - flags: --mail-port + port: 587 + # disable mail tls - flags: --mail-disable-tls + disable_tls: true +``` + +After updating configuration don't forget to restart your cozy-stack : +```bash +docker-compose restart cozy +``` diff --git a/docs/ecolyo/application/release.md b/docs/ecolyo/application/release.md new file mode 100644 index 0000000000000000000000000000000000000000..90bc6d151cc47dc8808d4404b29a142c167f47f8 --- /dev/null +++ b/docs/ecolyo/application/release.md @@ -0,0 +1,40 @@ +# Release + +This section will show you how to properly create a release for the app. + +## Conventionnal commit + +The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. + +The commit message should be structured as follows: + +``` +<type>[optional scope]: <description> + +[optional body] + +[optional footer(s)] +``` + +The commit contains the following structural elements, to communicate intent to the consumers of your library: + +* fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). +* feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). +* BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. +* types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. +* footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format. + +## standard-version + +Standard-version is librairie javascript that allow to handle easly tags and changelog file. + +Just run the following command in order to create a release tag, bump package.json version and upadte changelog file. + +```bash +yarn run release -- --release-as X.X.X # replace with version number (ex: 1.2.0) +``` + +## Usefull links +[Conventional commit doc](https://www.conventionalcommits.org/en/v1.0.0/) + +[Lib link](https://github.com/conventional-changelog/standard-version) \ No newline at end of file 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 6130717ef2570ad1aa19ea988ebb99a06376a78d..af3d4d08b08014e45a4f891c655943c733797767 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,10 +25,11 @@ extra_css: nav: - Home: index.md - Easy Cozy: - - Scripts: easycozy/scripts.md + - Configuration: easycozy/config.md - Commands: easycozy/commands.md - - Tips: easycozy/tips.md - Known errors: easycozy/known_errors.md + - Scripts: easycozy/scripts.md + - Tips: easycozy/tips.md - Ecolyo: - Introduction: ecolyo/index.md - Getting started: @@ -42,8 +43,11 @@ nav: - DocTypes: ecolyo/project_architecture/doctypes.md - Remote DocTypes: ecolyo/project_architecture/remote_doctypes.md - Application: + - Deploy: ecolyo/application/deploy.md - Description: ecolyo/application/description.md + - Gitflow: ecolyo/application/gitflow.md - Redux: ecolyo/application/redux.md + - Release: ecolyo/application/release.md - Scaffolding: ecolyo/application/scaffolding.md - Gitflow: ecolyo/application/gitflow.md - Deploy: ecolyo/application/deploy.md @@ -96,6 +100,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