diff --git a/docs/assets/changelog.png b/docs/assets/webapp/changelog.png similarity index 100% rename from docs/assets/changelog.png rename to docs/assets/webapp/changelog.png diff --git a/docs/assets/webapp/contact.png b/docs/assets/webapp/contact.png new file mode 100644 index 0000000000000000000000000000000000000000..2ee4a3896be6e2812d58e5094ac32e1860f14cbb Binary files /dev/null and b/docs/assets/webapp/contact.png differ diff --git a/docs/assets/credits.png b/docs/assets/webapp/credits.png similarity index 100% rename from docs/assets/credits.png rename to docs/assets/webapp/credits.png diff --git a/docs/assets/data.png b/docs/assets/webapp/data.png similarity index 100% rename from docs/assets/data.png rename to docs/assets/webapp/data.png diff --git a/docs/assets/download-resources.png b/docs/assets/webapp/download-resources.png similarity index 100% rename from docs/assets/download-resources.png rename to docs/assets/webapp/download-resources.png diff --git a/docs/assets/webapp/feedback.png b/docs/assets/webapp/feedback.png new file mode 100644 index 0000000000000000000000000000000000000000..db1b5f321bed58b0bdccfcafa32c0a7180e61784 Binary files /dev/null and b/docs/assets/webapp/feedback.png differ diff --git a/docs/assets/filters.png b/docs/assets/webapp/filters.png similarity index 100% rename from docs/assets/filters.png rename to docs/assets/webapp/filters.png diff --git a/docs/assets/webapp/footer.png b/docs/assets/webapp/footer.png new file mode 100644 index 0000000000000000000000000000000000000000..21297f99e9dd849ad4ae5821246e420a6436ee57 Binary files /dev/null and b/docs/assets/webapp/footer.png differ diff --git a/docs/assets/geo-services.png b/docs/assets/webapp/geo-resources.png similarity index 100% rename from docs/assets/geo-services.png rename to docs/assets/webapp/geo-resources.png diff --git a/docs/assets/webapp/header.png b/docs/assets/webapp/header.png new file mode 100644 index 0000000000000000000000000000000000000000..dc5920ce782c436bcddc128090958c7ec6f1a8a6 Binary files /dev/null and b/docs/assets/webapp/header.png differ diff --git a/docs/assets/homepage.png b/docs/assets/webapp/homepage.png similarity index 100% rename from docs/assets/homepage.png rename to docs/assets/webapp/homepage.png diff --git a/docs/assets/webapp/other-resources.png b/docs/assets/webapp/other-resources.png new file mode 100644 index 0000000000000000000000000000000000000000..b6e9fe93b1684679807e8d8ab8e6fd5972db8c58 Binary files /dev/null and b/docs/assets/webapp/other-resources.png differ diff --git a/docs/assets/webapp/partners.png b/docs/assets/webapp/partners.png new file mode 100644 index 0000000000000000000000000000000000000000..b455d4096762b68a2acde9a33e1413e7c1c91445 Binary files /dev/null and b/docs/assets/webapp/partners.png differ diff --git a/docs/assets/webapp/reuses.png b/docs/assets/webapp/reuses.png new file mode 100644 index 0000000000000000000000000000000000000000..1792a83ea58baeb98fbb2379d07eea3eb211bd1e Binary files /dev/null and b/docs/assets/webapp/reuses.png differ diff --git a/docs/assets/search.png b/docs/assets/webapp/search.png similarity index 100% rename from docs/assets/search.png rename to docs/assets/webapp/search.png diff --git a/docs/assets/webapp/sidemenu.png b/docs/assets/webapp/sidemenu.png new file mode 100644 index 0000000000000000000000000000000000000000..ca686eae2cce4b9682133db390a6aaa41a99def7 Binary files /dev/null and b/docs/assets/webapp/sidemenu.png differ diff --git a/docs/assets/suggestion.png b/docs/assets/webapp/suggestion.png similarity index 100% rename from docs/assets/suggestion.png rename to docs/assets/webapp/suggestion.png diff --git a/docs/assets/web-app-project-structure.png b/docs/assets/webapp/web-app-project-structure.png similarity index 100% rename from docs/assets/web-app-project-structure.png rename to docs/assets/webapp/web-app-project-structure.png diff --git a/docs/components/custom-apps/web-app/changelog.md b/docs/components/custom-apps/web-app/changelog.md index af7ca2ebe1e8c00845ab41d513d63050c9bc6131..de91a65f7ba58221377d3ebd85af3c4c0c1fd197 100644 --- a/docs/components/custom-apps/web-app/changelog.md +++ b/docs/components/custom-apps/web-app/changelog.md @@ -1,6 +1,6 @@ # Changelog - + In order to keep our users updated with the latest features developped and bugs that have been fixed, we implemented a changelog feature. diff --git a/docs/components/custom-apps/web-app/contact.md b/docs/components/custom-apps/web-app/contact.md index f35982058be7d7b604469354cccc9074d74b2a15..ad6cef8403544185a56f492b86f6975df6b227e7 100644 --- a/docs/components/custom-apps/web-app/contact.md +++ b/docs/components/custom-apps/web-app/contact.md @@ -1,5 +1,7 @@ # Contact + + The contact page allow a user to contact the support team through the [email](../../services/mailer.md) service. When a user is not logged in, he/she will need to fill some personal information (firstname, lastname, email) in order for the support team to be able to reply. In the case he/she is logged in the information will already be completed. diff --git a/docs/components/custom-apps/web-app/credits.md b/docs/components/custom-apps/web-app/credits.md index 98e44853fc01ca33bc92bb0f762539dd2eb773a2..7ecaf4d5695cda4cc1dce39768ed7a24994cc3d1 100644 --- a/docs/components/custom-apps/web-app/credits.md +++ b/docs/components/custom-apps/web-app/credits.md @@ -1,6 +1,6 @@ # Credits - + This page lists the open source tools used by data.grandlyon.com. diff --git a/docs/components/custom-apps/web-app/dataset/data.md b/docs/components/custom-apps/web-app/dataset/data.md index 0745a28fea1a9dbb6780b860feab9c32d401c7d7..46234b1a18ab8de3ac78b153a8a14b880bd2a891 100644 --- a/docs/components/custom-apps/web-app/dataset/data.md +++ b/docs/components/custom-apps/web-app/dataset/data.md @@ -2,7 +2,7 @@ This is the main page to observe the data of a dataset. This page has two components: a data table and a map. The map will be displayed only for geographical datasets (it makes sense). - + ## Fullscreen and Toggle Map/data diff --git a/docs/components/custom-apps/web-app/dataset/resources.md b/docs/components/custom-apps/web-app/dataset/resources.md index 66c596faf60c75ddcf1fce7aa5243aa958c34ed2..985ea37157ff1117b8f1926e94831202764edba9 100644 --- a/docs/components/custom-apps/web-app/dataset/resources.md +++ b/docs/components/custom-apps/web-app/dataset/resources.md @@ -21,13 +21,15 @@ We have one exception, the `WS` service. It is not a standard, and has been deve By the way, it is possible to select datasets with the services you want by using the [filters](../search.md#Filters) Here is an example of the page. - + For each service you have the possibility to create a custom reequest (exception for the `SOS` service) and change the options such as the output formats, the projection system or the regions. From that you can copy the custom request, or download the resources that link will give you. In the previous example in the picture, I would be able to download the image of the 'arbres d'alignement' dataset from the WMS (Web Map Service). ## Static resources - + ## Other resources + + diff --git a/docs/components/custom-apps/web-app/feedback.md b/docs/components/custom-apps/web-app/feedback.md index d99f29bd5a653a751423b587bf67299aac1cef62..53625a05516ea8a6e7e5d0ac6467628632cce88a 100644 --- a/docs/components/custom-apps/web-app/feedback.md +++ b/docs/components/custom-apps/web-app/feedback.md @@ -1,5 +1,7 @@ # 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. diff --git a/docs/components/custom-apps/web-app/footer.md b/docs/components/custom-apps/web-app/footer.md index 7fc92a07c2c84a1b89f3fbbdfe1354b66e1d1eed..e3de5c21e24a72050f2207a44bf375854a5d06c4 100644 --- a/docs/components/custom-apps/web-app/footer.md +++ b/docs/components/custom-apps/web-app/footer.md @@ -1,5 +1,7 @@ # Footer + + The footer is devided in three sections. The left section comports links to the facebook and twitter pages of the Lyon Metropolitan Area as well as the link to the RSS feed of the platform. diff --git a/docs/components/custom-apps/web-app/header.md b/docs/components/custom-apps/web-app/header.md index 7fb71a9c60ec2efd8078cf22108b21c26a1ffc9f..bbc6ae6ede5f654a5c97d9a6de7756484fbad2ad 100644 --- a/docs/components/custom-apps/web-app/header.md +++ b/docs/components/custom-apps/web-app/header.md @@ -1,5 +1,7 @@ # Header + + The header of the application has different display and content depending on two factors: * the screen size (mobile, tablet or desktop) diff --git a/docs/components/custom-apps/web-app/homepage.md b/docs/components/custom-apps/web-app/homepage.md index c099c94053b8d2e8bf31f8ec159a819695e003cd..4eed13ffdbd2a18ad0ee3096f32fa1b37b982f9e 100644 --- a/docs/components/custom-apps/web-app/homepage.md +++ b/docs/components/custom-apps/web-app/homepage.md @@ -1,6 +1,6 @@ # Homepage - + This is the landing page of data.grandlyon.com. diff --git a/docs/components/custom-apps/web-app/overview.md b/docs/components/custom-apps/web-app/overview.md index 590fed3d29cb448c91ccf540cd84cc4f30b2a6f2..ad6844f8ac3f43f0b31442ca78ee7c3368886999 100644 --- a/docs/components/custom-apps/web-app/overview.md +++ b/docs/components/custom-apps/web-app/overview.md @@ -6,7 +6,7 @@ Organize a folders and files structure inside a project is never an easy task, a We think that at the beginning we should just not overthink about it, choose one way to do it, keep to it, until a natural re-organization will happen if needed. Here is our `/src` folder structure: - + * `src/app/`: where the Angular code is located. With time we organized this part in different modules each taking care of one main functionnality. Here is the list of the modules: * `core/`: constitutes the base of the application (layout, notifications, navigation history...) diff --git a/docs/components/custom-apps/web-app/partners.md b/docs/components/custom-apps/web-app/partners.md index 2b7983795e94575c6cd4ffeaad53debaf4189d51..42db3200e93359d7332f0b3e2a09c32cc4a0e048 100644 --- a/docs/components/custom-apps/web-app/partners.md +++ b/docs/components/custom-apps/web-app/partners.md @@ -1,5 +1,7 @@ # Partners + + The Lyon Metropolitan Area has opened its portal to all stakeholders in the region who wish to distribute their data, in open data or restricted access. This page list the current partners. Each partner is represented as a card with its logo, a description, its website and the number of datasets and services distributed. diff --git a/docs/components/custom-apps/web-app/reuses.md b/docs/components/custom-apps/web-app/reuses.md index c690c307605bf44f8ed047d6c20b07b64f8fa5cd..702cfc88efe6e04f012895eed9b1c53420d70f69 100644 --- a/docs/components/custom-apps/web-app/reuses.md +++ b/docs/components/custom-apps/web-app/reuses.md @@ -1,5 +1,7 @@ # Reuses + + The Lyon Metropolitan Area promotes the reuse of territorial data: analysis, map, site, service, application... This page lists thoses reuses. The reuses are displayed as a card with their logo, name, creator, type and the number of datasets they use. Each reuse is clickable and redirects to the detail page of the reuse in question. diff --git a/docs/components/custom-apps/web-app/search.md b/docs/components/custom-apps/web-app/search.md index 3bc6dfc277c18225bc46c7ac1211d3c3837648e1..4bdc1d499cf5641f0d94a10f3f6e24b44a380719 100644 --- a/docs/components/custom-apps/web-app/search.md +++ b/docs/components/custom-apps/web-app/search.md @@ -9,7 +9,7 @@ Here are the features existing on the portal: Of course there is a plenty of room for improvements for these features (and for new ones). ES is very powerful but also very complex to master. It's in a constant improvement. - + ## Datasets results @@ -24,7 +24,7 @@ See the [search bar](./header.md#Search-bar) documentation ## Filters - + On the left side of the screen the user has the possibility to add filters and subfilters (depending the category) These categories (e.g. producers, licences, formats) are based on the metadata properties. Then each value for these properties are aggregated. @@ -37,6 +37,6 @@ On another hand, if the user selects different filters in different filter categ ## Suggestion - + This is a useful feature, especially for typo. If your research doesn't give you any result, Elasticsearch might find for you a word that is close of yours that would give more success in the results. diff --git a/docs/components/custom-apps/web-app/side-menu.md b/docs/components/custom-apps/web-app/side-menu.md index f4d33934f533faa82f7dd6e12e33f2814c71e21b..e4b5a16c4f7870e0c35fd7434892830de77b983a 100644 --- a/docs/components/custom-apps/web-app/side-menu.md +++ b/docs/components/custom-apps/web-app/side-menu.md @@ -2,6 +2,8 @@ The purpose of the side menu is to help the user to easily navigate through the main pages of the website without altering the user experience. Indeed, to avoid that it takes to much place on the left, a hide and show system as been developed. + + ## Draft button The first section of the menu is constituted of internal links to the principal pages of the application. Though, there is one particular link, `Drafts`, that is only displayed when the user has access to articles that haven't been published yet. This is the case when the user belongs to the `ghost-editors` group. To verify that, a request is made to the elasticsearch service in order to get the drafts, if none are return it means the user doesn't have the appropriate rights and so the button is hidden. Please refer to [this]() section of the documentation to understand how the elasticsearch service can return different content depending on the user's groups.