search

etalab / doc.data.gouv.fr

Documentation du site data.gouv.fr.
https://doc.data.gouv.fr
MIT License
7 stars 53 forks source link

Workflow template <> doc #16

Closed noirbizarre closed 5 years ago

noirbizarre commented 6 years ago

Problems

Right now the synchronization between doc.data.gouv.fr and template.data.gouv.fr is quite difficult and painful:

Needs

We need something allowing to:

Solutions ?

  1. Publish a npm package with template.data.gouv.fr assets
  2. Use the template.data.gouv.fr repository as a git submodule
bboulesteix commented 5 years ago

Pour remettre une pièce dans la machine, j’ajoute que la séparation entre le contenu de la documentation (qui se trouve dans le dépôt doc.data.gouv.fr) et le design de la documentation (qui se trouve dans le dépôt template.data.gouv.fr) m’a un peu dérouté au début.

C’est peut-être une question d’habitude, je ne sais pas. 🤔 Cela dit, la documentation de Jekyll semble recommander de transformer les thèmes Jekyll en gem Ruby, ce qui revient à cacher certains répertoires, comme _sass ou _layouts — et ce qui n’est donc pas si loin de notre fonctionnement actuel. 🙂

Réponse

Pour répondre à @noirbizarre :

Publish a npm package with template.data.gouv.fr assets

Je crois voir que c’est ce qui a finalement été décidé. Super ! C’est d’ailleurs ce que font les américains du US Digital Service — ce qui ne constitue en aucun cas un argument d’autorité. 🦅

Remarques

Trois remarques pour aller plus loin :

  1. Le design de https://doc.data.gouv.fr devrait un peu changer, pour accueillir une page d’accueil, des pages pour chaque section, et intégrer une fonctionnalité de recherche, la partie _layouts du template va donc de moins en moins m’intéresser — mais la partie _sass va continuer de me servir ;
  2. À terme, je pense que https://doc.data.gouv.fr aura son propre thème Jekyll, un thème spécifique, qui pourra ensuite être systématisé et ouvert, pour servir de modèle à d’autres sites dont la vocation est de présenter de la documentation ;
  3. J’ai l’impression que nous utilisons l’excellent travail mené sur https://template.data.gouv.fr davantage comme on pourrait utiliser Bootstrap que comme un thème Jekyll au sens strict du terme et dont on exploiterait tout le potentiel (Minima par exemple), ce que j’interprète comme le signe que le thème est prêt pour être transformé en gem Ruby — Bootstrap existe d’ailleurs sous la forme d’une Gem Ruby.

J’ajoute que mes remarques n’engagent à rien.

Question

Quel avenir envisages-tu pour https://template.data.gouv.fr, @thimy ? Ton avis compte beaucoup.

Tu vois le template évoluer :

  1. En design system (pardon pour l’emploi de jargon en vogue 😎), c’est-à-dire comme un répertoire de composants prêts à l’emploi (boutons, formulaires, alertes), un peu à la manière de Bootstrap ?
  2. En modèles de pages, c’est-à-dire comme un répertoire de structures de contenu dont il suffirait de récupérer le HTML pour les répliquer dans d’autres projets (page d’accueil, article d’aide, page équipe), un peu à la manière de ce que propose le USDS ?
  3. En thème Jekyll pour produire de beaux sites statiques dans l’administration, ce qui situerait alors https://template.data.gouv.fr à mi-chemin entre la bibliothèque de composants et le répertoire de modèles de pages, un peu à la manière de https://federalist.18f.gov ?

Je suis conscient qu’il s’agit d’une question compliquée. Je ne la pose pas pour obtenir une réponse définitive et catégorique, mais plutôt pour savoir si je peux aider, et comment je peux aider, à faire grandir https://template.data.gouv.fr — que j’utilise déjà tous les jours avec grand plaisir. 🙂

thimy commented 5 years ago

Merci pour ce retour détaillé ! À vrai dire une bonne partie du travail a déjà été effectuée, le problème c’est que je n’ai pas vraiment pris le temps de le documenter. 🙇‍♀️

Petit inventaire qui devrait déjà répondre un peu à tes remarques.:

En ce qui concerne les questions : J'aimerais pouvoir avoir d'énormes ambitions en ce qui concerne template.data.gouv.fr et pouvoir satisfaire les trois points que tu as évoqués. Mes réserves viennent de plusieurs choses :

Donc dans l'absolu, j'ai envie de faire toutes ces choses mais je n'y arrive pas, et c'est pas facile de faire cet aveu d'échec. :D Je pense qu'il sera difficile d'en faire un design system adopté par toutes les administrations, la plupart aime avoir sa propre identité, mais on peut déjà créer au moins un design system pour Etalab, ce serait un début. ;) Je réfléchis de plus en plus à en refaire la structure et éventuellement son design global, quitte à le reprendre en partie ou en totalité, mais avec de l'aide, du conseil et des guidelines pour en faire quelque chose de vraiment bien. Enfin, mon ultime ambition serait de réussir à en faire un espace collaboratif pour le faire évoluer de façon collective et non pas à mon seul gré.

bboulesteix commented 5 years ago

Merci pour ta réponse @thimy. 👍

Il faut vraiment que j’ouvre les yeux, car je crois que je n’avais pas bien saisi la nuance entre https://github.com/etalab/template.data.gouv.fr/ et https://github.com/etalab/template-jekyll — je m’arrêtais au mot « template ». 🤦‍♂️ Encore merci pour tes explications, donc.

Enfin, pour te répondre :

Je réfléchis de plus en plus à en refaire la structure et éventuellement son design global, quitte à le reprendre en partie ou en totalité, mais avec de l'aide, du conseil et des guidelines pour en faire quelque chose de vraiment bien.

Ça me semble être une excellente idée ! Il y a un tel besoin de cohérence graphique que ton travail profiterait à de nombreux projets, c’est certain. En tout cas, de mon côté, je reste dans le coin si jamais tu as besoin de bras. 💪

taniki commented 5 years ago

@noirbizarre @bboulesteix Est-ce que vous pouvez splitter cette issue en plusieurs activables ? J'ai l'impression qu'actuellement le problème est mal formulé ce qui en fait un truc insolvable et qu'on ferait mieux de fermer l'issue en attendant.