From e0b9f6e576d4993f82f315292688d3a41b5d187d Mon Sep 17 00:00:00 2001 From: PEDROLI Benjamin <benjamin.pedroli@soprasteria.com> Date: Thu, 11 Mar 2021 10:24:11 +0100 Subject: [PATCH] add pilote docs --- docs/pilote/Pilote - Usager/application/doctypes.md | 13 ++++++++++++- .../Pilote - Usager/functionalities/appointments.md | 1 + .../Pilote - Usager/functionalities/contact.md | 6 ++++++ .../Pilote - Usager/functionalities/document.md | 1 + .../Pilote - Usager/functionalities/setting.md | 8 ++++++++ mkdocs.yml | 5 +++++ 6 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/pilote/Pilote - Usager/functionalities/appointments.md create mode 100644 docs/pilote/Pilote - Usager/functionalities/contact.md create mode 100644 docs/pilote/Pilote - Usager/functionalities/document.md create mode 100644 docs/pilote/Pilote - Usager/functionalities/setting.md diff --git a/docs/pilote/Pilote - Usager/application/doctypes.md b/docs/pilote/Pilote - Usager/application/doctypes.md index dcccd05..32009aa 100644 --- a/docs/pilote/Pilote - Usager/application/doctypes.md +++ b/docs/pilote/Pilote - Usager/application/doctypes.md @@ -16,9 +16,20 @@ 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 + ## 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 0000000..19b7d0a --- /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 0000000..781f465 --- /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 0000000..ab86519 --- /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 0000000..2e733ef --- /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 4b5f757..9f02056 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,6 +51,11 @@ nav: - 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 -- GitLab