Un nouveau site pour Gladys 4?

Salut à tous !

Alors que la v4 a déjà été installé plus de 1 200 fois depuis le lancement de l’alpha, le site Gladys actuel (gladysassistant.com) est encore le site créé pour la v3. J’ai progressivement masqué les informations relatives à la v3, mais ce n’est pas facile, ce site n’a pas été conçu pour la v4 ^^ Le design du site est encore un vieux thème bootstrap 3, pas facile à mettre à jour.

J’aimerais repenser le site pour permettre aux nouveaux arrivants de bien comprendre Gladys 4, et leur donner envie de se lancer dans l’aventure ! :slight_smile:

L’objectif de ce topic, c’est de parler de ce que l’on veut sur le site, et de comment on va le mettre en place.

Spécifications fonctionnelles

Pour moi, le site d’un produit open-source doit répondre aux questions :

  • Que fait le logiciel ? Est-ce que je peux faire XXX ?
  • Avec quoi s’intègre Gladys ? Quels périphériques exactement ? J’ai un périphérique “fibaro XX”, est-il géré par Gladys ?
  • Comment installer Gladys ? Sur un Raspberry Pi ? Sur un Synology ? Sur une freebox delta ?
  • J’ai une question, je la pose ou ?

Dans cette optique, j’ai commencé à faire un design d’un site pour Gladys 4:

C’est un design fonctionnel, le design en lui même (police, etc) n’est pas du tout fait ici.

Vous remarquerez plusieurs choses:

  • La documentation est de retour sur le site principal. Je pense que la documentation, c’est le coeur d’un projet open-source, et je trouve ça dommage de le mettre sur un domaine séparé, comme si ce n’était pas important: c’est le plus important!
  • On a souvent parlé d’un onglet “Integrations” qui recense tous les périphériques gérés par Gladys. J’ai pas mal réfléchi au truc, et je commence à voir comment on va l’intégrer. Pareil, ça a sa place sur le site principal Gladys. @AlexTrovato ça va t’intéresser :wink:
  • Chaque device géré a sa page à lui, et il est possible de commenter sur la page du “device” pour poser des questions. A voir si on peut intégrer Discourse sur cette page pour que les messages soient sur le forum :slight_smile:

Spécification techniques

  • On est un projet open-source, le site doit être open-source comme il est actuellement. Tout le monde peut éditer le site :slight_smile:
  • Le site est multi-langue (EN/FR)
  • Les articles de blogs sont stockés en markdown dans des fichiers
  • Les intégrations sont stockés en markdown dans des fichiers (un fichier par intégration & par langue)
  • Le site est généré et statique

Au niveau du générateur de site statique, actuellement nous utilisons Jekyll, un générateur de site statique écrit en Ruby. Il fonctionne bien, mais il est assez lent à la génération + le fait qu’il soit écrit en Ruby n’est pas pratique: je n’y connais rien en Ruby et on est vite bloqué dès qu’on veut faire quelque chose de custom :smiley:

J’aimerais passer à un générateur en Javascript, comme Gastby ou NextJS. J’ai l’impression que NextJS est plus simple que Gastby, mais je n’ai pas encore trop choisi entre les deux :smiley:

Qu’en pensez-vous ?

1 « J'aime »

Que tu es dev JS y’a pas de doute ^^

Blague à part , je te rejoins sur la doc et les intégrations. pour le reste j’ai pas trop d’avis.

Généralement quand j’arrive sur un site avec ce type d’accueil ( Slider / Features etc… ) , le 1er truc que je cherche c’est la doc et souvent pour répondre à cette question :arrow_up:
Et quand la doc n’a pas de barre de recherche, je passe mon chemin ( oui, la flemme :slight_smile: )


Je sais pas si t’as vu mais nextjs ont fait un guide pour l’utilisateur, je trouve le truc sympa

2 « J'aime »

Moi aussi ! Actuellement j’aime pas vraiment ce qu’on a, je pense que ça sera plus simple à comprendre pour les nouveau arrivants

Ca me fait penser que j’ai oublié la barre de search sur la documentation, ça doit être la base

Je l’utilise depuis plusieurs année :slight_smile: Sur le site + le forum. En fait il y a déjà une page de compatibilité que j’avais fais pour Gladys v3 ( https://gladysassistant.com/fr/compatibilities/ ), mais je l’ai masqué pour l’instant vu qu’elle n’est pas à jour

Après le programme partenaire Amazon ça rapporte vraiment pas grand chose, je compte plutôt sur Gladys Plus pour être soutenu sur mon travail :slight_smile:

Pour l’instant ce n’est pas prévu, c’est une complexité supplémentaires de gérer plusieurs plan d’abonnements, un c’est déjà bien pour l’instant :smiley:

@lidian c’est gentil ! Pour l’instant on est plus à la conception qu’à l’implémentation, je posterais un message quand je me lancerais sur le site :slight_smile:

En attendant, n’hésite pas à nous aider sur Gladys en elle même, c’est du Preact (React plus léger) + Node.js, et on a plein de todos en attentes! ( Issues · GladysAssistant/Gladys · GitHub ), tout aide est la bienvenue :wink:

Sinon j’aime beaucoup Docusaurus:

Ca permet de faire des sites avec une doc hyper clean, du search, dark mode, le tout build depuis des fichiers Markdown et les page customs sont en React.

Sauf que leur v2 n’est pas encore compatible avec l’internationalisation…

J’hésite beaucoup entre commencer un nouveau site sous Next.js mais je risque pas mal de réinventer ce que fait Docusaurus nativement, ou attendre que Docusaurus sorte sa v2 pour pouvoir migrer notre site

Je viens de tester rapidement, c’est pas mal et rien que pour le dark theme je dis oui ^^.

Je penses que ça vaut le coup d’attendre, et rien ne nous empêche de commencer le boulot avant.

Effectivement on peut très bien commencer avec juste un site en français par exemple, le mettre sur un autre domaine ( genre un sous domaine de gladysassistant.com), en attendant qu’ils releasent l’internationalisation. Mais bon ce qui me fait peur c’est qu’ils soient lent et qu’il sortent ça dans 1 an… Je crois qu’ils bossent sur la v2 depuis 2018

J’ai fais des premiers tests avec Docusaurus v2, ça en jette !

Ils utilisent Infima pour le style, c’est vraiment pas mal

Copieur :smiley:

1 « J'aime »

Aha :smiley: En attendant d’avoir l’internationalisation dans Docusaurus, je me demande ce qui nous empêche de créer 2 dossiers (un “fr” et un “en”), et d’avoir 2 projets Docusaurus différents. On peut essayer de mutualiser au max les fichiers (components React pour la homepage par exemple), mais sinon les .md seront tous différents

https://github.com/facebook/docusaurus/issues/789#issuecomment-634721378

J’ai vu, mais bon “hopefully sometime in the next couple of months.” c’est pas forcément rassurant :smiley:

Après bon, avec ce qu’on a déjà, je suis sûr qu’on peut déjà construire un site en/fr en séparant juste les deux sites et en faisant une double génération

Comme la rc1 de Gladys :smiley: #joke

1 « J'aime »

Fais en 20 minutes:

Hyper cool ce tool ! :slight_smile:

J’ai mis ce premier poc sur un repo Git :

Maintenant il faut arriver à faire le double site “fr/en” pour l’internationalisation

Je viens de finir de migrer la documentation EN:

Maintenant je me lance sur la doc FR.

Ensuite il restera:

  • Le blog FR
  • Le blog EN
  • La homepage EN+FR

Je tenterais surement de faire un premier déploiement sur un sous nom de domaine avant de pusher le truc total :slight_smile:

1 « J'aime »

Booon

:white_check_mark: Doc FR done
:white_check_mark: Doc EN done

Je suis sur la page des intégrations maintenant !