Mise à jour de la documentation

Bonjour,

Comme certains le savent, nous travaillons depuis plusieurs mois sur une refonte de la documentation. Une première pièce est arrivée hier avec le passage sur la nouvelle interface des docs pour le core de jeedom (uniquement à partir du site de doc, en direct, ce sera à partir de vos Jeedom avec la prochaine version du core), et les tutos + premiers pas + compatibilité….. tout sauf les plugins.

Pour la partie technique (pour ceux que ça intéresse), on passe maintenant en github page avec jekyll et un thème maison, ce qui nous oblige à convertir toutes les docs de asciidoc à markdown et à passer la branche principale sur github à master. Donc une fois la migration finie on aura 2 branches : beta et master.

Hormis l’interface, le gros avantage de ce changement c’est qu’on ne gère plus la génération de la doc qui commençait à prendre trop de temps (plus de 24h) et n’était donc plus possible.

Maintenant nous allons petit à petit migrer les plugins vers ce nouveau système puis refaire aussi la page de présentation du site de doc pour que vous puissiez plus facilement retrouver une information dedans.

Autre bonne nouvelle de ce changement, il devrait résoudre les soucis de 404 lorsque vous voulez aller sur une doc depuis votre Jeedom (pour rappel la même chose depuis le site de doc marche). Nous profitons aussi de ce changement pour normaliser les changelogs et donc essayer de vous en proposer plus souvent (pour rappel si rien dans le changelog c’est soit une correction d’orthographe, le robot de traduction, l’ajout ou le retrait d’un espace… enfin rien d’important)

Pour les développeurs tierces nous allons mettre à jour le plugin template pour que vous voyez comment faire.

Cet article a été lu 3364 fois

Vous aimerez aussi...

22 réponses

  1. Sartog dit :

    Excellente nouvelle et j’aime beaucoup cette nouvelle présentation des doc !
    Très réussi.
    Et le changelog sera un vrai plus.

    Pour info, dans la page Core -> Administration, les liens se trouvant au dessus du chapitre 1 n’envoie pas au chapitre sélectionné.

  2. fwehrle dit :

    Excellente nouvelle. Beau boulot.
    Ca devrait aussi alléger un peu les demandes sur le forum.
    Vivement la prochaine release du core. 😀

  3. David dit :

    Merci pour le boulot surtout quand on sait que la doc, c’est rarement la partie la plus fun pour les développeurs 😉

  4. Yoguiti dit :

    Je vous suis toujours avec la même attention et la même passion. Encore un progrès !
    Merci à toute l’équipe !

  5. coulox dit :

    merci à la team. j’adore surtout les chapitres sur la gauche

  6. Pierremillien dit :

    Hello les Jeedomeurs,
    Bravo pour la nouvelle documentation, elle est claire, très bien organisée et facile a suivre. Depuis que je me suis repenché dedans, j’ai amélioré passablement de choses dans ma box. Merci

  7. superbricolo dit :

    Bravo pour cette mise à jour. La nouveau thème est vraiment top, je le trouve beaucoup plus lisible. Bon courage pour toutes ces migrations. Et merci de rendre notre Jeedom encore plus accessible. C’était un peu agaçant l’accès pas toujours intuitif au doc. Maintenant ça va être aux petits oignons.

  8. Broshet dit :

    Hello

    Il y a pas un bug dans la page « Application Mobile » car les tableaux sont tous représentés en texte brut (voir paragraphe 4.2) ?

  9. Dslade47 dit :

    Bonjour et bravo pour cette belle doc, c’est un gros manque qui est comblé.
    Pour les changelogs, c’est bienvenue aussi.
    Merci à la team Jeedom pour le travail fourni !

  10. guenneguez_t dit :

    Super bonne nouvelle.

  11. TaG dit :

    Hello,

    Super tout ça même si j’avais bien vu les nouveautés.
    Je post assez tardivement pour une question qui me tient à cœur.
    Si Nibb me lit, il doit avoir une idée déjà.

    Est-ce qu’avec ce nouveau système de Doc, on peut balancer des images en faisant des PR ?
    Le soucis d’espace disque disparait ou pas du tout avec cette mise à jours des docs ?

    Merci

    • loic dit :

      Bonjour,
      On a toujours pu faire des PR sur la doc sauf pour les plugins privée et ça ça ne change pas. Pour l’autre question je ne comprends pas…

  12. TaG dit :

    Oui, je suis bien d’accord pour les PR sur les docs.

    Ce que je veux dire, désolé si je me suis mal exprimé, c’est que j’avais arrêté de faire des mises à jours de documentation car j’ajoute des copies d’écrans, et ça allourdisait la documentation.

    Est-ce qu’avec ce nouveau mécanisme, je peux prévoir de me remettre sur les mises à jours de documentations en ajoutant des copies d’écrans ou non ?

    Suis-je plus compréhensible ?

    Merci

    • loic dit :

      Oui je comprends alors j’avoue que perso je n’aime pas trop les captures d’écran car lors d’un changement d’interface ca augmente pas mal le travail du dev. En ce qui concerne d’alourdir la doc on passe les images dans tinypng (de mémoire) pour reduire la taille. Sur le plugin zwave on a pu passer de quasiment 30mo à 14mo avec ca.

  13. TaG dit :

    Je vais tenter de mettre le moins possible quand je verrai une doc à compléter, mais ce n’est pas bloquant pour toi.

    C’est noté ;).

    Merci pour tes réponses ;).

  14. bcaro dit :

    il y a une date prévue pour la mise à disposition de la procédure et d’un tuto pour les dev tiers? Merci.

  15. jiminy dit :

    Bonjour Loic,
    J’ai vu ta réponse à bcaro
    Pour un nouveau plugin que recommande tu pour le moment en attendant ?
    juste un dossier doc avec les fichiers index.md et changelog.md dans fr_FR comme çà çà préserve l’avenir çà ne charge pas trop le plugin, et c’est lisible dès aujourd’hui sur le dépot Github du plugin ?
    J’étais parti de template en laissant tous les fichiers de docs et je me suis rendu compte que çà alourdissait mon plugin de plusieurs Mo (comme d’ailleurs plusieurs plugins tiers mis récemment sur le market d’ailleurs attention à l’embonpoint !) donc aujourd’hui je vire tout en ne laissant que les .md car je me vois mal faire de l’asciidoc et le traduire plus tard.

  16. jiminy dit :

    correction c’est docs et pas doc

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *