Avant toute chose merci de (re)prendre connaissance de la charte et de la respecter.
Pour résumer :
- Avant de poser une question, je cherche si la réponse existe
- Je suis poli, courtois et je respecte tout un chacun sur le forum
- Si un post m'agace : je m'en éloigne plutôt que de répondre d'une façon qui pourrait être mal interprétée


Il n'est jamais du luxe que de rappeler des choses simples :
Courtoisie, amabilité, politesse et bonne humeur sont les maîtres mots pour un forum sympathique, bienveillant et accueillant :)

Toute la communauté vous remercie

Recherche personne pour faire de la doc sur les modules

Retrouvez les informations officielles de Jeedom (nouvelle version, nouveaux lancements, tutos...)
Anou
Timide
Messages : 1
Inscription : 30 août 2017, 09:34

Re: Recherche personne pour faire de la doc sur les modules

Message par Anou » 30 août 2017, 09:38

loic a écrit :
14 juil. 2015, 12:37
Bonjour,

Dans le but de toujours plus facilité l'accessibilité à Jeedom nous sommes à la recherche de personnes pour faire des documentations sur les modules enOcean/Rfxcom. Cela demande pas mal de temps mais apportera un gros plus à Jeedom.

Voici des exemples de doc (déjà faite pour le zwave/edisio) :

https://jeedom.fr/doc/documentation/zwa ... rnode.html
https://jeedom.fr/doc/documentation/edi ... Volet.html

Les doc doivent être faite en asciidoc, voila des exemples pour les doc actuels (zwave/edisio) :
https://github.com/jeedom/doc-zwave-mod ... /doc/fr_FR
https://github.com/jeedom/doc-edisio-mo ... /doc/fr_FR

Bien sur tout travail (si correcte bien évidement) sera récompensé par des plugins/backups cloud/services pack

Merci d'avance pour les courageux qui tenteront. Si vous faite une doc sur un module dite le histoire que vous vous retrouviez pas à 2 sur le même module.

Je peux aider pour le plugin RFXcom.
J'ai pas mal de modules thermo/hydro, pince ampèremétrique, pluvio, anémo et une sonde piscine (pas utilisée pour le moment).
Dès que j'ai un peu de temps (pas facile avec ces journées à rallonge !).

yves273
Timide
Messages : 230
Inscription : 18 janv. 2016, 11:13

Re: Recherche personne pour faire de la doc sur les modules

Message par yves273 » 20 sept. 2017, 09:00

Bonjour,

J'avais pour objectif de corriger une doc d'un plugin, j'ai réussi à faire mes changements qui ont été validés par le développeur.
Pendant cette étape je l'ai fait intuitivement sans doc avec quelques infos récupérés ça et là (comme le pull request)
Voulant me faire une petite doc perso pour d'autres occasions j'ai eu beaucoup plus de mal à reproduire ce que j'avais fait car j'ai pris les subtilités de l'IHM (très américaine) en pleine figure et en cherchant mieux je me suis retrouvé sur ce fil.

La proposition de @tag du 24 aout m'a permis de conforter mes connaissances mais si c'est le point d'entrée d'un contributeur dans l'outil, il y a de quoi être repoussé.

1- je pense donc que ta dernière partie doit être le point d'entrée (avec les bons mots et les copies d'écrans) c'est ce que j'ai du faire
Tu fork la documentation jeedom vers ton profil
tu ajoute quelque chose
tu fais un pul request
tu ne peux pas le merger, il est juste sous soumis ton pull request, il faut qu'une personne en charge du repos valide ton PR ;).
2- j'ai d'autres interpellations
-la structure du document n'est pas évoquée et la il y a des variantes suivant le développeur
-l'arborescence des documents (master, beta) et les conséquences sur les maj du plugin d'un document mergé c'est important aussi, dans mon cas une branche patch-1 a été créée, que comprendre?

Une interface complexe est mise à disposition il faut en simplifier la compréhension au maximum, autrement cela ne peut pas marcher.
Les développeurs sont culturellement allergiques à écrire, aux docs, aux changelog..., là c'est l'expérience qui parle mais n'avez vous pas remarqué que le marketing de l'envie marche bien (aussi pour les plugins jeedom) mais derrière il y a un gros gaspillage d'objets qui finissent dans les fonds de tiroir.
Comment voulez-vous faire quand on reçoit une notice en chinois et là github c'est un peu du chinois.

TaG
Actif
Messages : 903
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 21 sept. 2017, 23:01

Je n'ai pas oublié ce sujet, j'ai juste pas mal de choses en cours. Je vais y arriver.

Après je suis un pauvre débutant, j'essayerai de faire au mieux. Les corrections seront les bienvenues :)!

TaG
Actif
Messages : 903
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 27 sept. 2017, 09:39

Tite question

J'ai vu dans le blog jeedom ceci :

Remise à jour de toute la documentation :
Toute les docs ont été revues
Suppression des images pour faciliter la mise à jour et le multilingue

Donc, j'ai plus le droit aux images sur les demandes de modifications de documentation ? vous allez trouver un moyen de contournement ? ou j'ai mal compris ?

Je dois repartir un peu sur les documentations, genre celle pour le Pull Request que j'ai laissé ici, mais je voudrais la mettre sur la documentation officielle. Il y a par contre beaucoup de copies d'écrans, sinon c'est imbitable :(

Merci d'avance

noodom
Timide
Messages : 307
Inscription : 13 juil. 2014, 17:25

Re: Recherche personne pour faire de la doc sur les modules

Message par noodom » 27 sept. 2017, 10:06

TaG a écrit :Tite question

J'ai vu dans le blog jeedom ceci :

Remise à jour de toute la documentation :
Toute les docs ont été revues
Suppression des images pour faciliter la mise à jour et le multilingue

Donc, j'ai plus le droit aux images sur les demandes de modifications de documentation ? vous allez trouver un moyen de contournement ? ou j'ai mal compris ?

Je dois repartir un peu sur les documentations, genre celle pour le Pull Request que j'ai laissé ici, mais je voudrais la mettre sur la documentation officielle. Il y a par contre beaucoup de copies d'écrans, sinon c'est imbitable :(

Merci d'avance
Oui, c’est ce que je crains aussi.. un problème de lisibilité et de compréhension des docs sans images (ou même limitées). Les captures, c’est quand même super efficace pour le lecteur mais aussi pour le rédacteur qui a pas à partir dans des discours de folie..



Envoyé en utilisant Tapatalk

Avatar de l’utilisateur
Nibb31
Actif
Messages : 1799
Inscription : 17 févr. 2015, 15:29

Re: Recherche personne pour faire de la doc sur les modules

Message par Nibb31 » 10 oct. 2017, 16:01

Les screenshots sont une très mauvaise pratique en documentation. Ca empêche la traduction et ça rend difficile les mises à jour.
Un bon rédacteur doit pouvoir s'en passer. D'autant plus que l'utilisateur a théoriquement l'interface graphique à coté.

Par contre, ça implique que l'interface graphique ait été conçue correctement, avec un nom clair et unique sur chaque champ, ce qui n'est pas le cas de Jeedom, notamment pour les commandes action/info.
Jeedom: 2.x stable en VM ProxMox sur HP Microserver N54L
Z-wave: Z-stick Aeonlabs S2
433MHz: RFXCom433E
Hue

Avatar de l’utilisateur
magicgg91
Actif
Messages : 10922
Inscription : 09 août 2014, 12:15
Localisation : Région Parisienne
Contact :

Re: Recherche personne pour faire de la doc sur les modules

Message par magicgg91 » 10 oct. 2017, 16:03

C'est pour ça que dans les dernières révisions de doc officielles, la majorité des captures a été supprimée, pour qu'elle soit maintenable plus facilement dans le temps et par diverses personnes.
Bêta-Testeur | Jeedom | VM Debian 9, Clé Aeon Labs Gen5, Xiaomi Gateway
Protocoles | Zwave, Hue, Bluetooth, Wifi, Zigbee | Mon matériel : ici

DomoPi - Mon site dédié au Raspberry Pi et à la domotique

Charte du forum | Doc jeedom | Trucs et astuces

TaG
Actif
Messages : 903
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 11 oct. 2017, 09:54

Nibb31 a écrit :
10 oct. 2017, 16:01
Les screenshots sont une très mauvaise pratique en documentation. Ca empêche la traduction et ça rend difficile les mises à jour.
Un bon rédacteur doit pouvoir s'en passer. D'autant plus que l'utilisateur a théoriquement l'interface graphique à coté.
Merde, je voulais aider, mais vu que je voulais mettre des copies d'écrans, je vois que je suis un mauvais rédacteur.
Dommage

Merci d'avance pour tes doc Nibb

Avatar de l’utilisateur
Nibb31
Actif
Messages : 1799
Inscription : 17 févr. 2015, 15:29

Re: Recherche personne pour faire de la doc sur les modules

Message par Nibb31 » 11 oct. 2017, 10:21

Il ne faut pas te sentir agressé comme ça.

Je suis rédacteur technique de métier, alors je passe mes journées à en faire, de la doc. Du coup, j'ai du mal à me motiver pour en faire en dehors du taf, désolé.

Par contre, je peux donner des conseils. Se passer des copies d'écran, c'est souhaitable, pour les raisons évoquées au dessus, et ce n'est pas difficile. C'est généralement plus efficace de lister les noms des éléments d'IHM et de donner leur description ou fonction. Malheureusement, l'IHM de Jeedom ne s'y prête pas, parce que beaucoup d'éléments d'IHM n'ont pas de nom.
Jeedom: 2.x stable en VM ProxMox sur HP Microserver N54L
Z-wave: Z-stick Aeonlabs S2
433MHz: RFXCom433E
Hue

DJo86
Timide
Messages : 181
Inscription : 29 déc. 2015, 13:48
Localisation : Poitiers

Re: Recherche personne pour faire de la doc sur les modules

Message par DJo86 » 14 oct. 2017, 15:36

Bonjour,
J'ai lu ce topic car je souhaite apporter ma petite contribution quand je vois des erreurs dans les docs de plugin par exemple. Mais quand je lis ce topic, j'ai l'impression d'être sur une autre planète quand je lis certains commentaires avec des mots ou phrases qui me sont inconnus pour moi qui ne suis pas développeur. Je ne souhaite pas mettre dans le topic du plugin qu'il y a une erreur dans la doc car ça ne sert à rien et je préférerai modifier avec validation du concepteur directement.
J'espère avoir été clair.
Merdi de me dire si cela est possible ?
Bonne journée à tous !
DJo
Joli job, merci à toute l’équipe Jeedom et aux développeurs externes !!!

Avatar de l’utilisateur
magicgg91
Actif
Messages : 10922
Inscription : 09 août 2014, 12:15
Localisation : Région Parisienne
Contact :

Re: Recherche personne pour faire de la doc sur les modules

Message par magicgg91 » 14 oct. 2017, 15:42

Bonjour,

Oui c'est possible, sur github, il faut faire un fork de la doc ou du plugin en question, faire tes corrections et ensuite faire un pull request.
Cela a été expliqué un peu plus en détails.
Bêta-Testeur | Jeedom | VM Debian 9, Clé Aeon Labs Gen5, Xiaomi Gateway
Protocoles | Zwave, Hue, Bluetooth, Wifi, Zigbee | Mon matériel : ici

DomoPi - Mon site dédié au Raspberry Pi et à la domotique

Charte du forum | Doc jeedom | Trucs et astuces

TaG
Actif
Messages : 903
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 05 nov. 2017, 12:46

Hello,

En attendant de pouvoir créér dans le how-to, car sans images, ça va être coton.

Désolé pour les possibles fautes

Mais vu que j'avais un pull à faire grace à Tomdom :) !

Voici une procédure pour déposer une requête de modification d'un document sur github

Je pars du principe que vous avez déjà un fork du projet ou vous souhaitez pousser une modification.

Dans mon cas, je souhaite donc pousser une modification sur le fichier history.class.php
Ce fichier se situe dans le core de jeedom et plus précisément ici : core/class/

1 On est donc sur mon dépôt (TaGGoU91 / core) qui est indiqué comme étant un fork de Jeedom/core
2 On se rend donc dans /core/class (le premier core est en gras, c'est le dépôt ou je suis (core, cf Petit 1)
3 On a donc notre fichier history.class.php - On clique sur le fichier

Image

1 On est donc bien dans notre fichier
2 On clique sur le crayon pour entrer en modification

Image

Afin de faire une recherche dans le fichier (dans mon cas, je ne suis pas Dev, ni créateur du fichier que l'on va modifier, je ne sais donc pas ou ce situe le bout de code que je veux modifier).
Il faut en premier, faire un clic avec la souris DANS le bloc ou il y a le code
Ctrl + F
Coller le texte que vous cherchez (un élément significatif et une ligne seulement, pas tout un bloc d'un coup)
Entrée

Si vous ne cliquez pas dans la fenêtre contenant le texte ou le code que vous cherchez, c'est la recherche du navigateur qui va s'ouvrir, et dans mon cas, sur Google chrome, ça ne sait pas faire la recherche dans le code ou la documentation directement.

1 Le champ de recherche, oui c'est assez mince comme information, la ligne copié est bien plus grande ;).

Image

1 En jaune, c'est le résultat de la recherche
2 En bleu, ce que je viens de sélectionner et que je souhaite modifier/remplacer par le bloc code fournit par Tomdom (encore merci à toi !!! )

Image

Je supprime donc le bloc puis je le remplace.

Ensuite, sur la partie basse on trouve ceci :
1 On indique un titre explicite si possible
2 On entre une description un peu plus précise (dans mon cas, ça serait trop long, le lien vers le forum sera plus parlant)
3 On s'assure que ça soit bien coché comme ceci
4 On commit !

Image

Non, ça n'est pas terminé, on ne va pas manger un gâteaux pour se féliciter :D

1 On clique sur l'onglet Pull Request
2 New Pull Request (PR pour les intimes)
Image

1 On est ce coup-ci logique, on compare la base de jeedom avec notre repository à nous
2 Celà indique les modifications (le premier c'est parce que je me suis remis à jour depuis jeedom, le second concernant justement le changement de la fonction lastchangestateduration, parfait !!!)
3 L'ancien code
4 Le nouveau code
5 On créé le Pull Request (PR)

Image


1 On clique sur les trois petits points
2 On recopie les informations que l'on a saisi précédemment
3 Idem, on recopie (d’où l'utilisation des ... à l'étape 1 pour s'éviter une réécriture)
4 On clique sur Create Pull Request

Image

C'est terminé.
Il n'y a que les utilisateurs ayant un droit de push sur jeedom qui peuvent valider le PR.
Pour vous assurez que votre modification est bien dans la liste, vous pouvez cliquer sur Pull Requests

Image

On obtient la liste des PR en attente de validation
1 On voit bien le notre

Image



Je ne sais pas si c'est normal de voir le pr concernant la mise à jour depuis le core vers mon repository

tonnerre33
Timide
Messages : 111
Inscription : 28 déc. 2015, 15:44
Localisation : Bordeaux

Re: Recherche personne pour faire de la doc sur les modules

Message par tonnerre33 » 05 nov. 2017, 20:58

Ton tuto est parfait, merci beaucoup

TaG
Actif
Messages : 903
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 05 nov. 2017, 21:07

tonnerre33 a écrit :
05 nov. 2017, 20:58
Ton tuto est parfait, merci beaucoup
Merci pour ton retour ;)!!!

tonnerre33
Timide
Messages : 111
Inscription : 28 déc. 2015, 15:44
Localisation : Bordeaux

Re: Recherche personne pour faire de la doc sur les modules

Message par tonnerre33 » 05 nov. 2017, 21:13

TaG a écrit :
05 nov. 2017, 21:07
tonnerre33 a écrit :
05 nov. 2017, 20:58
Ton tuto est parfait, merci beaucoup
Merci pour ton retour ;)!!!
De rien par contre j'ai une question, j'ai lu dans les discussions précédentes et dans ton tuto qu'il y a une histoire de branche "beta" mais je ne la trouve pas dans le jeedom/core ni dans le jeedom/doc :(

SI tu pouvais m'en dire un peu plus sur ce beta ^^ ca serait sympas (dans ton tuto, je l'ai vu dans "comparing changes" TaGGoU91/core compare beta)

merci d'avance

Edit : c'est sur ce post que j'ai lu qu'il fallait pousser en beta avec une confirmation loic ;)
viewtopic.php?f=57&t=9057&start=80#p495940
Dernière édition par tonnerre33 le 05 nov. 2017, 21:15, édité 1 fois.

TaG
Actif
Messages : 903
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 05 nov. 2017, 21:14

Me faut un pc pour tester ça.

Avatar de l’utilisateur
Sabato
Timide
Messages : 135
Inscription : 23 janv. 2017, 11:25

Re: Recherche personne pour faire de la doc sur les modules

Message par Sabato » 09 nov. 2017, 23:33

Bonjour,

je me posais la question quand on propose une modification sur une doc, est-ce qu'il faut le faire sur le fichier qui regroupe tout les chapitres ou sur le fichier du chapitre ou sur les 2 ?

Par exemple j'ai proposer une correction dans le Yeelight.asciidoc du plugin xiaomi de lunarok. La correction a été accepté mais je ne la retrouve pas dans le fichier configuration.asciidoc.

Il etait ecrit "prametres" au lieu de "parametres"
Jeedom SMART avec :
- 3xFibaro FGR222, 1xFGK-101, 1xFGMS-001-ZW5, 1xFGS-213
- Broadlink RM PRO (pour prise chacon et télécommande IR de ma TV et ampli)
- Nest
- Dash button
- Gateway Xiaomi avec 3 sondes de température
- Bandeau led yeelight xiaomi

Répondre

Revenir vers « Annonces officielles »

Qui est en ligne ?

Utilisateurs parcourant ce forum : Aucun utilisateur inscrit et 1 invité