GitLab

Description

Il serait intéressant d'offrir la possibilité de modifier/d'ajouter/supprimer des liens/textes sur les footers et headers des instances Validata.

Par exemple, si nous communiquons sur la validation de données IRVE, il n'est pas très opportun dans le header d'avoir un lien vers la documentation SCDL.

De même, nous pourrions vouloir ajouter des liens vers nos outils de remplissage (csv-gg) dans le header ou le footer par exemple.

Comment pourrions-nous nous y prendre pour cela ?

Tâches

validata-ui

• créer un fichier config.yaml qui reprenne le fichier homepage_config.json (cf exemple ci-dessous)
• modifier la variable d'environnement HOMEPAGE_CONFIG_FILE en CONFIG_FILE
• utiliser Pydantic pour valider la lecture de ce fichier
• supprimer homepage_config.json.example et ajouter config.example.yaml (mettre example avant yaml pour les éditeurs de code)
• mettre à jour la phrase du footer, cf #75 (comment 2208)

validata-ops

• dans l'overlay, dans le ConfigMap homepage-config remplacer la clé homepage-config.json par config.yaml
• dans l'overlay, dans le Deployment validata-ui mettre à jour la variable d'environnement : HOMEPAGE_CONFIG_FILE et adapter le nom du volume et le point de montage (homepage-config devient config)

Notes

L'instance Validata d'OpenDataFrance sera configurée en utilisant ce nouveau fichier, comme n'importe quelle instance.

Exemples

# config.yaml
footer:
  links:
    - title: API
      url: https://go.validata.fr/api/v1/apidocs
header:
  links:
    - title: Mode d'emploi
      url: https://validata.fr/doku.php?id=utilisation
homepage:
  sections:
    - name: schema-catalog
      title: A catalog of schemas
      description: This is a catalog of schemas that is published somewhere.
      catalog: https://git.opendatafrance.net/scdl/catalog/raw/master/catalog.json