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

Refonte de la documentation (avec Eleventy) #858

Merged

Conversation

loup-brun
Copy link
Contributor

@loup-brun loup-brun commented Apr 25, 2023

Voir #845

note: il y a un bug actuellement qui empêche les changements faits aux components d’être actualisés en mode de développement lorsqu’ils sont importés par un layout, voir cette issue sur github:
11ty/eleventy#2903

Le fix sera livré dans la prochaine version patch d’Eleventy (donc bientôt)
@netlify
Copy link

netlify bot commented May 4, 2023

Deploy Preview for stylo-dev ready!

Name Link
🔨 Latest commit 4daec9a
🔍 Latest deploy log https://app.netlify.com/sites/stylo-dev/deploys/64f771fbfc679b0008aa02df
😎 Deploy Preview https://deploy-preview-858--stylo-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link

netlify bot commented May 24, 2023

Deploy Preview for stylo-docs ready!

Name Link
🔨 Latest commit 521c3e8
🔍 Latest deploy log https://app.netlify.com/sites/stylo-docs/deploys/64fb3d3a2a897000074d87eb
😎 Deploy Preview https://deploy-preview-858--stylo-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@loup-brun loup-brun changed the title (WIP) refonte doc: intégration eleventy Refonte de la documentation (avec Eleventy) Jun 9, 2023
@loup-brun
Copy link
Contributor Author

loup-brun commented Jun 9, 2023

@antoinentl @ggrossetie @thom4parisot
Cette PR est prête pour révision. Il resterait à configurer l’hébergement (avec le compte Netlify cela devrait être très facile), mais aussi à entrer certaines métadonnées pour que les pages s’affichent correctement (ex. balise title au lieu d’un h1 dans le corps).

TODO:

@loup-brun
Copy link
Contributor Author

stylo-doc-neue-menu
stylo-doc-neue

@ggrossetie
Copy link
Collaborator

Si c'est possible je pense que ça pourrait être bien d'avoir https://docs.stylo-dev.huma-num.fr

Pratique pour faire d’autres sections, ex. /v2 ex. /blog ex. /nouvelles
@loup-brun
Copy link
Contributor Author

Thème/couleurs de la nouvelle doc

Est-ce que quelqu’un pourrait donner une rétroaction par rapport à l’intégration des nouvelles couleurs de la CRCÉN dans la doc? (cc en particulier @marviro, mais aussi les contributeurs comme @antoinentl @mattheyje @Mmellet) Voici un aperçu du travail sur la doc en l’état (accessible en prévisualisation ici) :

Screenshot 2023-06-13 at 11-38-51 Stylo - un éditeur de texte sémantique Stylo

Screenshot 2023-06-13 at 11-38-43 Stylo - un éditeur de texte sémantique Stylo


Il serait aussi possible d’avoir un jeu de couleurs complètement neutre, reflétant l’état actuel de l’interface de Stylo. Voici ce à quoi ça pourrait ressembler (jeu de couleurs en niveaux de gris) :

Screenshot 2023-06-13 at 11-58-55 Syntaxe markdown Stylo

Screenshot 2023-06-13 at 11-59-00 Syntaxe markdown Stylo

@loup-brun
Copy link
Contributor Author

@loup-brun
Copy link
Contributor Author

Ajout de la fonctionnalité de recherche (tel que suggéré par @Mmellet).

stylo-doc-recherche

@antoinentl
Copy link
Member

Je suis partagé entre la version couleur et la version en noir et blanc (ou niveaux de gris), les deux sont lisibles. Voici mes arguments :

  • version couleur : un peu de couleurs fait du bien, mais nous pourrions réinjecter ces couleurs dans Stylo pour les rares endroits où il y en a ;
  • version noire et blanc : plus cohérente avec l'interface (actuelle) de Stylo, et peut-être plus élégante (mais c'est subjectif).

Je laisse @mattheyje @Mmellet et @marviro réagirent, le choix qui sera fait sera le bon choix.

@mattheyje
Copy link
Collaborator

Je suis partagé entre la version couleur et la version en noir et blanc (ou niveaux de gris), les deux sont lisibles. Voici mes arguments :

* version _couleur_ : un peu de couleurs fait du bien, mais nous pourrions réinjecter ces couleurs dans Stylo pour les rares endroits où il y en a ;

* version noire et blanc : plus cohérente avec l'interface (actuelle) de Stylo, et peut-être plus élégante (mais c'est subjectif).

Je laisse @mattheyje @Mmellet et @marviro réagir, le choix qui sera fait sera le bon choix.

Je suis d'accord avec tous les points soulevés par Antoine et vois aussi des avantages aux deux possibilités...peut-être que le NB est plus élégant en effet ? À voir avec @Mmellet et @marviro

@antoinentl
Copy link
Member

Après en avoir discuté avec @RochDLY et @marviro, on part sur la version en noir et blanc/neutre/niveaux de gris. Et nous pouvons déployer dès qu'on le peut, avec quelques tâches supplémentaires :

  • rediriger le lien vers la documentation depuis Stylo
  • rediriger stylo-doc.ecrituresnumeriques.ca vers stylo.huma-num.fr/doc en 301 @antoinentl
  • rediriger toutes les pages (en 301) ? @loup-brun je suis preneur de ton avis

@loup-brun
Copy link
Contributor Author

màj du 8 septembre :

  • l'interface de la doc est en niveaux de gris.
  • les fichiers sont à jour avec master.
  • favicon avec couleurs neutres (différence système clair et foncé).
  • certains agencements de couleurs ont été corrigés.

Screenshot 2023-09-08 at 10-50-47 Stylo - un éditeur de texte sémantique Stylo


Screenshot 2023-09-08 at 10-51-03 Stylo - un éditeur de texte sémantique Stylo

@RochDLY RochDLY merged commit 714abac into EcrituresNumeriques:master Sep 8, 2023
@loup-brun loup-brun deleted the 845-refonte-documentation branch September 8, 2023 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants