From 7c720ee5143f1fa0ba7f049b92230c6257f19dfe Mon Sep 17 00:00:00 2001
From: PEDROLI Benjamin <benjamin.pedroli@soprasteria.com>
Date: Wed, 3 Mar 2021 10:47:32 +0100
Subject: [PATCH] add Pilote documentation
---
docs/pilote/Pilote - TS - Back/index.md | 2 +-
docs/pilote/Pilote - TS - Front/application/deploy.md | 2 +-
.../Pilote - TS - Front/functionalities/functions.md | 11 +++++++++++
docs/pilote/Pilote - TS - Front/index.md | 9 ++++++++-
mkdocs.yml | 8 ++++++--
5 files changed, 27 insertions(+), 5 deletions(-)
create mode 100644 docs/pilote/Pilote - TS - Front/functionalities/functions.md
diff --git a/docs/pilote/Pilote - TS - Back/index.md b/docs/pilote/Pilote - TS - Back/index.md
index 60729ec..531f19d 100644
--- a/docs/pilote/Pilote - TS - Back/index.md
+++ b/docs/pilote/Pilote - TS - Back/index.md
@@ -15,4 +15,4 @@ Pilote is a social application.
- DEV : https://pilote-agent-dev.grandlyon.com/
- REC : https://pilote-agent-rec.grandlyon.com/
-
+- PROD : https://pilote-agent.grandlyon.com/
diff --git a/docs/pilote/Pilote - TS - Front/application/deploy.md b/docs/pilote/Pilote - TS - Front/application/deploy.md
index 694c97d..c54a693 100644
--- a/docs/pilote/Pilote - TS - Front/application/deploy.md
+++ b/docs/pilote/Pilote - TS - Front/application/deploy.md
@@ -1,4 +1,4 @@
-### Deployment
+# Deployment
For each environment, the CI-CD is implemented.
diff --git a/docs/pilote/Pilote - TS - Front/functionalities/functions.md b/docs/pilote/Pilote - TS - Front/functionalities/functions.md
new file mode 100644
index 0000000..e48e624
--- /dev/null
+++ b/docs/pilote/Pilote - TS - Front/functionalities/functions.md
@@ -0,0 +1,11 @@
+This section explains the different functionalitites :
+
+# Beneficiairies
+
+Once you are authenticated, you'll redirect into /liste-beneficiaire route.
+
+You are getting all usager known.
+
+# Sharing
+
+For each beneficiary, you can ask the sharing. It means that you will be redirect into the public page of the cozy usager. In the same time, one process is running in order to send the sms. This sms contain one sharecode in order to provide some right on the cozy usager.
\ No newline at end of file
diff --git a/docs/pilote/Pilote - TS - Front/index.md b/docs/pilote/Pilote - TS - Front/index.md
index 8e14e10..5710f13 100644
--- a/docs/pilote/Pilote - TS - Front/index.md
+++ b/docs/pilote/Pilote - TS - Front/index.md
@@ -6,4 +6,11 @@ Pilote is a social application.
[Pilote gitlab repository](https://forge.grandlyon.com/solidarite/monparcourssocial)
-[Pilote TS front - gitlab repository](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial)
\ No newline at end of file
+[Pilote TS front - gitlab repository](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial)
+
+
+## Acces to the application deployed
+
+- DEV : https://pilote-agent-dev.grandlyon.com/
+- REC : https://pilote-agent-rec.grandlyon.com/
+- PROD : https://pilote-agent.grandlyon.com/
diff --git a/mkdocs.yml b/mkdocs.yml
index 04c101b..4b5f757 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -29,6 +29,8 @@ nav:
- Index: pilote/Pilote - TS - Back/index.md
- Application:
- Deploy: pilote/Pilote - TS - Back/application/deploy.md
+ - Functionalities:
+ - Routes: pilote/Pilote - TS - Back/functionalities/routes.md
- Getting Started:
- Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md
- Setup your environment: pilote/Pilote - TS - Back/getting_started/setup_your_environment.md
@@ -37,9 +39,11 @@ nav:
- Index: pilote/Pilote - TS - Front/index.md
- Application:
- Deploy: pilote/Pilote - TS - Front/application/deploy.md
+ - Functionalities:
+ - Routes: pilote/Pilote - TS - Front/functionalities/functions.md
- Getting Started:
- - Launch the application on local: pilote/Pilote - TS - Front/getting_started/launch_local_application.md
- - Pilote - TS - Usager:
+ - Launch the application on local: pilote/Pilote - TS - Front/getting_started/launch_local_application.md
+ - Pilote - Usager:
- Application:
- Deploy: pilote/Pilote - Usager/application/deploy.md
- Doctypes: pilote/Pilote - Usager/application/doctypes.md
--
GitLab