Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

retours Romtal sur la documentation #94

Open
JulienParis opened this issue May 19, 2020 · 3 comments
Open

retours Romtal sur la documentation #94

JulienParis opened this issue May 19, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request front

Comments

@JulienParis
Copy link
Contributor

JulienParis commented May 19, 2020

Retours de Romain sur les textes de la documentation publiée en anglais ici => https://etalab.github.io/dashboard-aides-entreprises/

@JulienParis JulienParis added documentation Improvements or additions to documentation enhancement New feature or request front labels May 19, 2020
@JulienParis
Copy link
Contributor Author

ping @romtal pour les retours sur ce sujet

@geoffreyaldebert
Copy link
Collaborator

Je m'incruste dans cet issue pour mettre mes retours ici aussi.
Déjà gros travail bravo c'est super. 👍

Remarques :

  • la police est un poil trop grande, ça complique un peu la lecture
  • il y a effectivement trop de texte sur les objectifs d'un tel produit, la vision stratégique, l'open data en France... Je pense que ce n'est pas le lieu approprié pour cela. La doc doit servir techniquement à comprendre l'applicatif de mon point de vue, et se cantonner à ça.
  • j'aurai besoin d'une page "aide au débug" car si je comprends bien la structure des fichiers de config, leur utilité, dans la pratique, j'ai du mal à les modifier. Il faut en effet modifier énormément de variables et de confs pour arriver à faire marcher l'outil. Et comme je ne connais pas bien Nuxt je ne sais pas bien l'utiliser pour le débugger. Une page là-dessus serait super.
  • ce qui m'intéresse aussi c'est la façon dont on peut faire évoluer l'outil et qui ne se retrouvera pas dans les configs. Ex : comment intégrer un troisième niveau de zoom ? Comment customiser une url pour geojson avec paramètre dans l'url ? Comment intégrer un graphique qui n'existe pas encore (ex: treemap, courbe, nuage de points...) ? Cette partie va au-delà des fichiers de conf je pense.
  • enfin je pense qu'il est temps de séparer ODAMAP du TdB aides aux entreprises sur un repo séparé. Ca facilitera le réusage et les tests, qu'en penses-tu ?

En tout cas bravo c'est un gros boulot et un bel effort de synthèse. Ca nous servira forcément.
Geoffrey

@JulienParis
Copy link
Contributor Author

merci pour tes retours @geoffreyaldebert ça donne pas mal d'idées de comment ça pourrait évoluer et quels pourraient être les plus gros problèmes à régler pour rendre l'outil plus user-friendly.

  • Je pense que le souci de la taille de police devrait être simple à corriger, j'ouvrirai une issue là-dessus ;
  • Sur les textes de cadrage on va sabrer c'est certain, j'attends les retours de @romtal avant de passer le texte à la guillotine (ceci dit ça m'a aidé à poser à plat qqs idées pour plus tard... to be continued) ;
  • Sur l'aide au débug c'est un point assez nodal... L'idée d'une page sur le débug de Nuxt est une très bonne idée pour commencer à simplifier la prise en main ;
  • Sur les évolutions c'est un point super intéressant. Je pense qu'une partie de la réponse se trouvera dans la roadmap, ce qui n'empêche pas de réfléchir à une page assez haute dans l'arborescence de la doc qui résumerait nos envies,
  • Sur la migration vers un repo isolé je pensais caler ça en début de V3, ça demandera qd mm de changer deux trois trucs dans tes exports (les fichiers *generate.sh)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request front
Projects
None yet
Development

No branches or pull requests

3 participants