Choisir la techno de doc

ecolabdata / ecospheres

Portail des données de la transition écologique et de la cohésion des territoires

https://ecologie.data.gouv.fr

2 stars 0 forks source link

Choisir la techno de doc #110

Closed streino closed 6 months ago

streino commented 6 months ago

Dans l'idéal même techno que pour la suite, mais si délais trop courts, faire au plus simple.

abulte commented 6 months ago

PI la nouvelle doc data.gouv.fr est hébergée chez gitbook

❯ nslookup guides.data.gouv.fr
Server:     8.8.8.8
Address:    8.8.8.8#53

Non-authoritative answer:
guides.data.gouv.fr canonical name = cd89c216a4-hosting.gitbook.io.
Name:   cd89c216a4-hosting.gitbook.io
Address: 172.64.147.209
Name:   cd89c216a4-hosting.gitbook.io
Address: 104.18.40.47

Perso je ne suis pas un grand fan de cet outil, je ne trouve pas l'interface très intuitive ou efficace. Mais je ne suis probablement pas dans la cible (i.e. je sais écrire du markdown et utiliser GitHub).

streino commented 6 months ago

J'ai créé un compte Gitbook pour tester. Le résultat est consultable sur : https://ecospheres.gitbook.io/ecologie.data.gouv.fr/

@Thesauruv @martyKN vous devriez avoir reçu des invitations. Pouvez-vous tester un peu et voir si ça vous convient ?

Si on part là-dessus, il faudra :

[ ] Demander un compte "open source" à Gitbook (data.gouv en a obtenu un)
[ ] Définir l'URL finale
[ ] Synchroniser avec Github (besoin d'un compte github dédié ?)
[ ] Switcher en "publish as unlisted" en attendant la release

streino commented 6 months ago

Quelques remarques à chaud :

Gestion de base de la table des matières et la nav dans la doc, positif par rapport à un simple git pages (qu'il faudrait complémenter d'un jekyll ou autre).
Prise en compte d'un format mobile.
Le système de review reprend l'approche PR Github. J'aime bien :)
L'intégration Github permet d'éditer le markdown directement depuis Github. Les modifs sont synchronisées automatiquement entre Github et Gitbook. Les PRs aussi ?
Je n'ai pas trouvé comment éditer en markdown depuis Gitbook. Seulement éditeur visuel ? Suffisant ? (sinon on peut tjs passer par la synchro Github)
Pas mal de possibilités d'intégration. Peut-être intéressant (figma, commentaires externes, etc.)

streino commented 6 months ago

On part sur gitbook.