diff --git a/docs/assets/data.png b/docs/assets/data.png new file mode 100644 index 0000000000000000000000000000000000000000..9b1aac582f2c8c366cf6cc297edd2461f905f63c Binary files /dev/null and b/docs/assets/data.png differ diff --git a/docs/assets/filters.png b/docs/assets/filters.png new file mode 100644 index 0000000000000000000000000000000000000000..4e2bb710d3b340b1d325e0a79a683cf7621afb4b Binary files /dev/null and b/docs/assets/filters.png differ diff --git a/docs/assets/geo-services.png b/docs/assets/geo-services.png new file mode 100644 index 0000000000000000000000000000000000000000..d87d4073cc62069d381e44e6a5ae00dd251bc09f Binary files /dev/null and b/docs/assets/geo-services.png differ diff --git a/docs/assets/search.png b/docs/assets/search.png new file mode 100644 index 0000000000000000000000000000000000000000..2a9782ba67530cc06c710b666575e6546dfdf578 Binary files /dev/null and b/docs/assets/search.png differ diff --git a/docs/assets/suggestion.png b/docs/assets/suggestion.png new file mode 100644 index 0000000000000000000000000000000000000000..908fd64d50868e3e0ee7877d9593792997981fb4 Binary files /dev/null and b/docs/assets/suggestion.png differ diff --git a/docs/components/custom-apps/web-app/dataset/data.md b/docs/components/custom-apps/web-app/dataset/data.md index b838a6e2dd7998a727cc095fb965b56a4750d93e..0745a28fea1a9dbb6780b860feab9c32d401c7d7 100644 --- a/docs/components/custom-apps/web-app/dataset/data.md +++ b/docs/components/custom-apps/web-app/dataset/data.md @@ -2,6 +2,8 @@ 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 To increase the flexibility and the comfort of the user to display the data, it's possible to put in fullscreen the components. diff --git a/docs/components/custom-apps/web-app/dataset/resources.md b/docs/components/custom-apps/web-app/dataset/resources.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..f310b20cf924af6ea779605adf8d5f2ced9c41e3 100644 --- a/docs/components/custom-apps/web-app/dataset/resources.md +++ b/docs/components/custom-apps/web-app/dataset/resources.md @@ -0,0 +1,31 @@ +# Resources + +We define a resource a piece of information that is associated to a dataset. A resource can be classified in three categories: + +* queryable resources: this is provided by the geographical APIs available for the dataset. +* static resources: a file that can be downloaded directly. For example a PDF, a CSV. +* others: all other types. It might be for example an URL of a website providing more information about the dataset + +## Queryable resources + +For each geographical dataset, there is one or multiple interfaces to access geographical data. These interfaces are standards defined by the Open Geospatial Consortium (OGC). +We have one exception, the `WS` service. It is not a standard, and has been developped for specfic needs for the Métropole de Lyon. + +* WMS (Web Map Service): allows to get map as images +* WFS (Web Feature Service): manipulate geographical information with coordinates and properties +* WCS (Web Coverage Service): retrieves coverages data (geospatial information representing space/time-varying phenomena) +* KML (Keyhole Markup Service): get XML-based files for GIS softwares +* SOS (Sensor Observation Service): query observation and sensor metadata +* WS + +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/search.md b/docs/components/custom-apps/web-app/search.md index e70f38c7b14573a0546b451d9f1c20c6328c15e3..3bc6dfc277c18225bc46c7ac1211d3c3837648e1 100644 --- a/docs/components/custom-apps/web-app/search.md +++ b/docs/components/custom-apps/web-app/search.md @@ -9,6 +9,8 @@ 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 As in many search tools the results are displayed in different tabs representing different results categories: `All`, `Data`, `Services` and the `News` (editorial content). @@ -22,6 +24,8 @@ 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. Inside one filter category, the values are sorted by the number of datasets. @@ -33,4 +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/services/resources-helper.md b/docs/components/services/resources-helper.md index 8e7e2c51398aac245dffbeca5470cfcc8d4b2cf4..1543313d27328efadabbe66ff99f7e9f8590c67f 100644 --- a/docs/components/services/resources-helper.md +++ b/docs/components/services/resources-helper.md @@ -1,6 +1,7 @@ # Resources service ## What it does + This service can provide lists of resources and formats. A resource is an entity representing some information, usually geographic, that can be accessed by a query (for example Web Map Service) or by downloading a file. One resource can be considered standard (e.g WMS protocol) or not standard (a custom service). Each resource is associated with one or many formats.