diff --git a/docs/ecolyo/Functionalities/analysis.md b/docs/ecolyo/Functionalities/analysis.md index 8a867f2f4ef147b55524c6886202efa0a302ceee..3ee5075c29739c8e9bcf08812f9c23b331dc64c5 100644 --- a/docs/ecolyo/Functionalities/analysis.md +++ b/docs/ecolyo/Functionalities/analysis.md @@ -18,6 +18,24 @@ Par exemple, le 3 juin, un utilisateur pourra voir son analyse de Mai. Les utilisateurs ne seront pas bloqués pour naviguer dans les dates précédentes, et s'il n'y a pas d'analyse à afficher, nous affichons des tirets à la place des données. +## Bloc rappel inscription à la newsletter + +Depuis la version 3.1.0 d'Ecolyo, l'inscription à la newsletter est facultative lors de la création du compte. Ce bloc permet de rappeler aux utilisateurs de s'inscrire à la newsletter. + + + +### Interactions + +Si l'utilisateur clique sur la croix, le message disparaît jusqu'au rechargement de l'application. Pour cela on met à jour la variable `haveSeenNewsletterReminder` à `true` dans le store de l'analyse. Celle-ci est initialisée à `false` lors du chargement de l'application. + +Si l'utilisateur clique sur le bouton "Je m'inscris", il est inscrit à la newsletter et le message disparaît. Pour cela on met à jour la variable `sendAnalysisNotification` à `true` dans le profil de l'utilisateur. + +Si l'utilisateur clique sur le bouton "Ne plus afficher", le message ne s'affichera plus jamais. Pour cela on met à jour la variable `isAnalysisReminderEnabled` à `false` dans le profil de l'utilisateur. Celle-ci est initialisée à `true` lors de la migration de l'application en version 3.1.0. + +### Affichage + +Le message est affiché en haut de l'écran, uniquement si l'utilisateur n'est pas déjà inscrit à la newsletter et qu'il n'a pas déjà fermé ce message durant la session ET qu'il n'a pas encore cliqué sur le bouton "Ne plus afficher". + ## Bloc Comparaison avec mois précédent ou année précédente Ce bloc est divisé en deux parties, une première concernant la température moyenne et l'autre la consommation. diff --git a/docs/ecolyo/Functionalities/terms.md b/docs/ecolyo/Functionalities/terms.md index 5be6e72387990c5101105625be0d24af4f00c151..68dd23c3cc9392a2a3d5944d541c40f6380c732f 100644 --- a/docs/ecolyo/Functionalities/terms.md +++ b/docs/ecolyo/Functionalities/terms.md @@ -4,7 +4,7 @@ This section explains the way we handle terms in the application. ## Description -The terms version is handled with the _io.cozy.terms_ doctype. It is incremented each time we edit the CGU, the data consent validation or the legal notices. Once we increment the terms version, the user will be prompted to accept these terms, otherwise we won't be able to access the app. +The terms version is handled with the *io.cozy.terms* doctype. It is incremented each time we edit the CGU, the data consent validation or the legal notices. Once we increment the terms version, the user will be prompted to accept these terms, otherwise we won't be able to access the app. ### Private Routes @@ -12,16 +12,18 @@ All routes are private, and are accessible only if the user has accepted the las The only public routes are : -- _/terms_ : shows the terms validation page, and is the main page the user is redirected to if his consent is outdated -- _/cgu_ : shows the CGU public page, accessible by the terms page -- _/legal_ : shows the Legal Notice public page, accessible by the terms page +- */terms* : shows the terms validation page, and is the main page the user is redirected to if his consent is outdated +- */cgu* : shows the CGU public page, accessible by the terms page +- */legal* : shows the Legal Notice public page, accessible by the terms page ### Terms management We check the terms acceptation in the **splash screen** while the application is initializing, if there is no consent (first connection), or the consent is outdated (update of terms), the user will be redirected to the terms acceptation page. -For the full terms acceptation process, the user has to check the two checkboxes (one for Data share consent, and one for CGU and Legal Notice) to unlock the terms acceptation button. Once he has accepted it, a new term doctype is created with the value _accepted_ to true. So he can access now the entire application. -We store in user's profile a boolean _showConsentModal_ that allows the app to know about the consent status. +For the full terms acceptation process, the user has to check the two checkboxes (one for Data share consent, and one for CGU and Legal Notice) to unlock the terms acceptation button. Once he has accepted it, a new term doctype is created with the value *accepted* to true. So he can access now the entire application. +We store in user's profile a boolean *showConsentModal* that allows the app to know about the consent status. + +If the user is not subscribed to the newsletter, a third facultative checkbox is displayed. If the user checks it, he will be subscribed to the newsletter. If there is a consent update, two cases are possible : diff --git a/static/img/ecolyo/newsletter-reminder.png b/static/img/ecolyo/newsletter-reminder.png new file mode 100644 index 0000000000000000000000000000000000000000..3f8efeb6dfd60ba2a6a6cc53810c84f4ef783f31 Binary files /dev/null and b/static/img/ecolyo/newsletter-reminder.png differ