generated from codegouvfr/eleventy-dsfr
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #53 from IGNF/feature/tutoriels
Ajout de la documentation entrepôt générale et référencement des tutoriels
- Loading branch information
Showing
40 changed files
with
646 additions
and
1,437 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,59 @@ | ||
--- | ||
title: Toutes les ressources pour utiliser cartes.gouv.fr | ||
title: Toutes les ressources techniques pour utiliser cartes.gouv.fr et les briques de la Géoplateforme | ||
layout: layouts/profil.njk | ||
--- | ||
|
||
Consultez nos guides, FAQ, tutoriels et documentations techniques pour vous accompagner dans la prise en main des outils de cartes.gouv.fr. | ||
Consultez nos guides, FAQ, tutoriels et documentations techniques pour vous accompagner dans la prise en main des outils de la Géoplateforme et cartes.gouv.fr. | ||
|
||
Documentation développeur... | ||
## Entrepôt Géoplateforme | ||
|
||
{% from "components/component.njk" import component with context %} | ||
|
||
<div class="fr-grid-row fr-grid-row--gutters"> | ||
|
||
<div class="fr-col-md-6"> | ||
|
||
{{ component("tile", { | ||
url: "/entrepot/concepts/", | ||
title: "Concepts de l'Entrepôt", | ||
description: "Présentation des concepts manipulés dans l'Entrepôt et workflow général d'alimentation", | ||
pictogram: "system/system.svg" | ||
}) }} | ||
|
||
</div> | ||
|
||
<div class="fr-col-md-6"> | ||
|
||
{{ component("tile", { | ||
url: "/tutoriels/", | ||
title: "Tutoriels d'utilisation de l'Entrepôt", | ||
description: "Accès au différents tutoriels, par type de données et d'usage", | ||
pictogram: "leisure/digital-art.svg" | ||
}) }} | ||
|
||
</div> | ||
|
||
<div class="fr-col-md-6"> | ||
|
||
{{ component("tile", { | ||
url: "/entrepot/openapi/", | ||
title: "Spécifications OpenAPI de l'API Entrepôt", | ||
description: "Détails de toutes les routes assurées par l'API Entrepôt", | ||
pictogram: "document/document.svg" | ||
}) }} | ||
|
||
</div> | ||
|
||
<div class="fr-col-md-6"> | ||
|
||
{{ component("tile", { | ||
url: false, | ||
externalUrl: "https://geoplateforme.github.io/sdk-entrepot/", | ||
title: "Documentation du SDK python", | ||
description: "Pour consommer l'API Entrepôt plus facilement avec des scripts développés en python", | ||
pictogram: "digital/coding.svg" | ||
}) }} | ||
|
||
</div> | ||
|
||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
title: Concepts de l'Entrepôt | ||
description: Présentation des concepts manipulés dans l'Entrepôt et workflow général d'alimentation | ||
date: git Last Modified | ||
tags: | ||
- Concepts Entrepôt | ||
- Terminologie | ||
- Workflow d'alimentation | ||
--- | ||
|
||
{% from "components/component.njk" import component with context %} | ||
|
||
{{ component("breadcrumb", { | ||
segments: [{ | ||
url: "/developpeur/", | ||
title: "Documentation développeur" | ||
}] | ||
}) }} | ||
|
||
## Workflow général d'utilisation de l'entrepôt | ||
|
||
![workflow-simple](/img/entrepot/workflow-simple.png){.fr-responsive-img} | ||
|
||
## Détail des différentes entités manipulées | ||
|
||
{{ component("table", { | ||
headers: ["Nom français", "Définition", "Terminologie API"], | ||
data: [ | ||
["Utilisateur", "Une personne authentifiée sur la plateforme", "user"], | ||
["Communauté", "Groupe d'utilisateurs avec certains droits sur la communauté en elle même et sur son éventuel entrepôt associé. Le terme 'espace de travail' désigne une communauté et l'entrepôt associé.", "community"], | ||
["Entrepôt", "Ensemble de données, fichiers statiques, configurations. Le terme 'espace de travail' désigne une communauté et l'entrepôt associé.", "datastore"], | ||
["Livraison", "Une donnée temporaire, point d'entrée des données sur la plateforme, exploitable par des traitements", "upload"], | ||
["Vérification", "Un script de vérification disponible sur la plateforme, exécutable sur une livraison", "check"], | ||
["Exécution de vérification", "Une exécution d'une vérification sur une livraison en particulier", "check execution"], | ||
["Donnée stockée", "Une donnée stockée de manière pérenne sur l'entrepôt", "stored_data"], | ||
["Traitement", "Un script de traitement des données, avec des paramètres et des contraintes sur le type de données en entrée et un type de donnée en sortie", "processing"], | ||
["Exécution de traitement", "Une exécution d'un traitement, avec des données en entrée et une en sortie, des valeurs de paramètre", "processing execution"], | ||
["Annexe", "Document indépendant, dont on choisit si il est diffusé publiquement et selon quel chemin", "annexe"], | ||
["Configuration", "Ensemble d'informations décrivant la manière de diffuser des données sur un géoservice", "configuration"], | ||
["Statique", "Fichier de configuration utilisé côté entrepôt, au niveau de la diffusion ou des traitement", "static"], | ||
["Offre", "Entité représentant la présence d'une configuration sur un point d'accès", "offering"], | ||
["Point d'accès", "Entité représentant un ensemble de serveurs de diffusion géographique, accessible via une URL", "endpoint"], | ||
["Permission", "Possibilité d'accès à une offre donnée à un utilisateur ou une communauté", "permission"], | ||
["Accès", "Autorisation d'une clé à consommer une offre", "access"], | ||
["TMS", "Un Tile Matrix Set, statique pour la plateforme, utilisé par les données stockées de type pyramide ROK4", "tms"] | ||
] | ||
}) }} | ||
|
||
![Liens entre les différentes entités](/img/entrepot/liens-entites.png "Liens entre les différentes entités"){.fr-responsive-img} | ||
|
||
![Workflow d'utilisation de l'entrepôt Géoplateforme annoté](/img/entrepot/workflow-annote.png "Workflow d'utilisation de l'entrepôt Géoplateforme annoté avec les entités entrepôt manipulée lors de l'étape"){.fr-responsive-img} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
module.exports = { | ||
tags: ["Géoplateforme", "Entrepôt"], | ||
layout: "layouts/page.njk", | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: Spécifications OpenAPI de l'API Entrepôt | ||
description: Détails de toutes les routes assurées par l'API Entrepôt | ||
date: git Last Modified | ||
showBreadcrumb: true | ||
swaggerui: true | ||
tags: | ||
- Spécifications OpenAPI | ||
- API Entrepôt | ||
--- | ||
|
||
{% from "components/component.njk" import component with context %} | ||
|
||
{{ component("breadcrumb", { | ||
segments: [{ | ||
url: "/developpeur/", | ||
title: "Documentation développeur" | ||
}] | ||
}) }} | ||
|
||
{{ component("swaggerui", { | ||
url: "https://data.geopf.fr/api/v3/api-docs", | ||
targetId: "swagger-ui-demo" | ||
}) }} |
Oops, something went wrong.