isogeo / doc-homepage Goto Github PK

View Code? Open in Web Editor NEW

0.0 3.0 0.0 2.05 MB

Homepage about Isogeo online documentations

Home Page: http://help.isogeo.com/

HTML 76.18% CSS 23.82%

documentation isogeo

doc-homepage's Introduction

Isogeo documentations homepage

A single and simple HTML page listing Isogeo online documentations (see Github repositories).

Deployment

It's deployed on Isogeo Azure (Storage v2 Static website) using Azure DevOps (see config):

Deployment rules:

each commit triggers a deployment on QA
each tagged commit triggers a deployment on PROD - see tags

doc-homepage's People

Contributors

Watchers

doc-homepage's Issues

Ajouter la documentation pour Isogeo Manager

créer le dépôt - @Guts
ajouter la structure de base - @Guts
créer le contenu - @leodarengosse
ajouter à la page d'accueil

Mise à jour de la page d'accueil

Doc à retirer :

API
API -SDK Python
Manager
Isogeo2office

Doc à ajouter :

provider (avec l'icône actuelle d'Isogeo2office) : https://help.isogeo.com/provider/
CKAN : https://help.isogeo.com/admin/fr/features/publish/ckan.html
DCAT : https://help.isogeo.com/admin/fr/features/publish/harvest_datagouv_fr.html
CSW : https://help.isogeo.com/admin/fr/features/publish/csw_server.html

Traduction de l'aide en ligne

Différentes possibilités :

traduction à la volée dans le navigateur --> ça demande aucun dev mais ça traduit des choses qu'il ne faut pas et on ne maîtrise pas le résultat
traduction préalable dans la pipeline pour générer les documentations pour une liste de langues fixe via un utilitaire qu'on pourrait également utiliser en local avant de push un commit pour contrôler le résultat + possibilité d'indiquer dans le .md source des segments de texte à ne pas traduire
traduire 'à la main' avant de commit avec des probablement géniales extensions VSCode

Pour traduction préalable à la mep, possibles librairies (pas beaucoup d'utilisation) :

Npm :

PyPI :

https://pypi.org/project/md_translate/

Pour mkdocs :

https://pypi.org/project/mkdocs-google-translate/

Ajouter le lien vers la doc du Scan FME

Gérer les anciens liens de l'aide APP

L'aide en ligne d'APP ayant été intégrée comme une documentation parmi les autres, les anciens liens ne seront plus valables. Exemple :

Pour tester :

http://help.qa.isogeo.com/fr/support/#bonnes-pratiques doit renvoyer sur http://help.qa.isogeo.com/admin/fr/support/#bonnes-pratiques
de même http://help.qa.isogeo.com/fr/noexist doit renvoyer sur http://help.qa.isogeo.com

Le lien sur l'aide de l'extracteur ne fonctionne pas

Page d'accueil help.isogeo.com
clic sur "Extracteur de données Isogeo" (http://help.isogeo.com/extractor/fr/index.html)
reste sur la page d'accueil

Mise à jour rapide et automatique du contenu

Problème

Depuis le passage de l'aide en ligne en HTTPS, Isogeo utilise un système appelé un Azure CDN (pour Content Delivery Network), qui copie en cache les fichiers et dossiers contenus dans l'Azure Blob Storage qui contient tous les fichiers de tous les repositories de l'aide en ligne. Plus d'informations ont été rédigées ici : https://github.com/isogeo/doc-homepage/wiki/https.

Problème : l'aide en ligne n'est pas mise instantanément à jour lorsqu'une modification est mise en production et validée par les pipelines Azure DevOps. Le soucis doit venir de l'absence de vidage du cache. En général, les modifications sont quand même affichées une à deux heures plus tard (à confirmer).

Pour résoudre cette issue, des informations sont peut-être disponibles sur cette page de la documentation Microsoft : https://docs.microsoft.com/fr-fr/azure/architecture/serverless/guide/serverless-app-cicd-best-practices.

Une idée à exploiter serait de modifier les pipelines Azure DevOps du projet Documentation en ajoutant l'exécution à la fin de la pipeline d'une requête Azure qui viderait le cache du point de terminaison. Chaque pipeline serait configurée pour ne vider que le dossier dans lequel elle publie.

Vider le cache

Si une mise en production a lieu et que les changements ne sont pas disponibles tout de suite :

se rendre sur le point de terminaison de l'aide en ligne,
cliquer sur le bouton "Vider" (ou "Purge"), et sélectionner le bouton "Vider tout",
attendre quelques minutes, et dans un nouvel onglet en navigation privée, vérifier que le contenu a bien été mis à jour.

Travail à effectuer

Ajouter à chaque pipeline de documentation une nouvelle tâche AzureCLI qui prendra cette forme :

- task: AzureCLI@1
  displayName: Purge endpoint cache
  inputs:
    azureSubscription: 'Isogeo - MPN(82885610-5841-4749-8d71-46f56b643ad2)'
    scriptLocation: 'inlineScript'
    inlineScript: 'az cdn endpoint purge --resource-group isogeo --profile-name isogeo-help --name prodisogeohelp --content-paths /admin/* --no-wait'

Modifier selon le repository le chemin d'accès à vider. Vous pouvez trouver la liste des chemins d'accès en consultant le contenu du Blob Storage.

A regarder : vérifier qu'il n'y a pas une règle supplémentaire à appliquer sur le CDN pour faire en sorte que le navigateur de l'utilisateur se mette à jour automatiquement aussi (pour qu'on ait pas à lancer l'aide en ligne en navigation privée pour avoir les dernières modifications).

Passer les aides en ligne en HTTPS

Plusieurs client nous font la demande d'accéder aux aides en ligne en HTTPS. Actuellement le site n'est disponible qu'en HTTP.

Ajouter le chatbot Pipedrive

Installation manuelle

Copier le snippet ci-dessous
Collez le code juste avant la fin de la section de votre site web

<script>window.pipedriveLeadboosterConfig = {base: 'leadbooster-chat.pipedrive.com',companyId: 52944,playbookUuid: 'f8cfa707-4771-46e2-b594-e685018dbf38',version: 2};(function () {var w = window;if (w.LeadBooster) {console.warn('LeadBooster already exists');} else {w.LeadBooster = {q: [],on: function (n, h) {this.q.push({ t: 'o', n: n, h: h });},trigger: function (n) {this.q.push({ t: 't', n: n });},};}})();</script><script src="https://leadbooster-chat.pipedrive.com/assets/loader.js" async></script>