diff --git a/docs/assets/webapp/dataset-detail.png b/docs/assets/webapp/dataset-detail.png new file mode 100644 index 0000000000000000000000000000000000000000..cbe9a73f31eca823ab2275737b484bdaca4238a3 Binary files /dev/null and b/docs/assets/webapp/dataset-detail.png differ diff --git a/docs/assets/webapp/downloads.png b/docs/assets/webapp/downloads.png new file mode 100644 index 0000000000000000000000000000000000000000..80bdb73709859c667d0da3ac71cdce34fdf5a883 Binary files /dev/null and b/docs/assets/webapp/downloads.png differ diff --git a/docs/components/custom-apps/web-app/credits.md b/docs/components/custom-apps/web-app/credits.md index f1417aa10b918b119db0fdc314ffdc7f8586d48e..f3c215fad6344aec78f7894432d27ca7a51c2b54 100644 --- a/docs/components/custom-apps/web-app/credits.md +++ b/docs/components/custom-apps/web-app/credits.md @@ -2,6 +2,6 @@  -This page showcases the Open Source initiatives powering the data.grandlyon.com Web platform. +This page showcases the Open Source initiatives powering the data.grandlyon.com Web platform. Content is fetched from the dedicated [credits service](../../services/credits.md). The logo, name and short description of each record are displayed. Each "card" is clickable and the click will open a new navigation tab, pointing at the address of the official website of the concerned record. diff --git a/docs/components/custom-apps/web-app/dataset/resources.md b/docs/components/custom-apps/web-app/dataset/api.md similarity index 99% rename from docs/components/custom-apps/web-app/dataset/resources.md rename to docs/components/custom-apps/web-app/dataset/api.md index 985ea37157ff1117b8f1926e94831202764edba9..db8e0870bc7fcabadbe07289fe1c8d7f08108d34 100644 --- a/docs/components/custom-apps/web-app/dataset/resources.md +++ b/docs/components/custom-apps/web-app/dataset/api.md @@ -1,4 +1,4 @@ -# Resources +# API We define a resource a piece of information that is associated to a dataset. A resource can be classified in three categories: diff --git a/docs/components/custom-apps/web-app/dataset/dataset-detail.md b/docs/components/custom-apps/web-app/dataset/dataset-detail.md new file mode 100644 index 0000000000000000000000000000000000000000..e478ea01f0354fc4cc86fc545660aeb5f5987237 --- /dev/null +++ b/docs/components/custom-apps/web-app/dataset/dataset-detail.md @@ -0,0 +1,12 @@ +# Dataset detail + +This page gives all the detail concerning one dataset. + + + +It's cut into one to four tabs: + +* [Data tab](./data.md): only if geographical data. It displays the data into a table and a map. +* [Information](./info.md): always display. It presents the metadata and other important information of the dataset. +* [Downloads](./downloads.md): a list of files available to download +* [API](./api.md): \ No newline at end of file diff --git a/docs/components/custom-apps/web-app/dataset/downloads.md b/docs/components/custom-apps/web-app/dataset/downloads.md new file mode 100644 index 0000000000000000000000000000000000000000..6134caf354191532dc1613efeb90461666974e22 --- /dev/null +++ b/docs/components/custom-apps/web-app/dataset/downloads.md @@ -0,0 +1,3 @@ +# Downloads + + \ No newline at end of file diff --git a/docs/components/custom-apps/web-app/overview.md b/docs/components/custom-apps/web-app/overview.md index 91796083c909c0e3dac8724c29e7397da5c37203..b523cab9cffb6412e4b8a952a29181c4709115ed 100644 --- a/docs/components/custom-apps/web-app/overview.md +++ b/docs/components/custom-apps/web-app/overview.md @@ -7,7 +7,8 @@ ## Routing By: -* `slug` + +* `slug` * `uuid` Let's explain how routing works! @@ -17,7 +18,7 @@ Let's explain how routing works! ## Files & Folders structure Organize a folders and files structure inside a project is never an easy task, and it exists many ways to do so. -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. +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: 