From 86f5d0d3e51aba77bf6eab0843881c33ddd6a1e4 Mon Sep 17 00:00:00 2001 From: FORESTIER Fabien <fabien.forestier@soprasteria.com> Date: Mon, 27 Jan 2020 15:17:56 +0100 Subject: [PATCH] Add documentation for credits, drafts and feeback features in the web app section --- docs/components/custom-apps/web-app/credits.md | 7 +++++++ docs/components/custom-apps/web-app/drafts.md | 5 +++++ docs/components/custom-apps/web-app/feedback.md | 5 +++++ 3 files changed, 17 insertions(+) diff --git a/docs/components/custom-apps/web-app/credits.md b/docs/components/custom-apps/web-app/credits.md index e69de29..8693070 100644 --- a/docs/components/custom-apps/web-app/credits.md +++ b/docs/components/custom-apps/web-app/credits.md @@ -0,0 +1,7 @@ +# Credits + +This page lists the open source tools used by data.grandlyon.com. + +The list is fetched from the dedicated [credits](../../services/credits.md) service. + +For each credit the page displays the logo, the name and a short description. Each card (credit) is clickable and will open a new tab at the address of the website of the credit. diff --git a/docs/components/custom-apps/web-app/drafts.md b/docs/components/custom-apps/web-app/drafts.md index e69de29..39c2403 100644 --- a/docs/components/custom-apps/web-app/drafts.md +++ b/docs/components/custom-apps/web-app/drafts.md @@ -0,0 +1,5 @@ +# Drafts + +This page is dedicated to the users belonging to the `ghost-editors` group. + +The purpose of the page is to list non published articles. Each article is presented with its image cover, title and the last modification date and are clickable. Clicking on an article redirects to the article's page and so we are able to preview it as it will be displayed once published. Thereby we can anticipate any display bug before the publication of the article. diff --git a/docs/components/custom-apps/web-app/feedback.md b/docs/components/custom-apps/web-app/feedback.md index e69de29..d99f29b 100644 --- a/docs/components/custom-apps/web-app/feedback.md +++ b/docs/components/custom-apps/web-app/feedback.md @@ -0,0 +1,5 @@ +# Feedback + +The goal of this feature is to provide users an easy way to give their opinion to the development team but also to submit any suggestions of improvment, problems or bugs they might have encountered. + +The feedback form is composed of a textarea for the feedback, a 'rating' field where the value can be `1 star`, `2 stars`, `3 stars` or `No opinion` and an optional email field if the user wants a reply from the team. If an email is provided the user has to accept the general term of use and the process of the information in order to sumbit its feedback. -- GitLab