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...)
Avatar de l’utilisateur
magicgg91
Actif
Messages : 9913
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 » 28 juil. 2017, 17:12

guillaumefons a écrit :
28 juil. 2017, 17:05
il faut que j' aille ou pour que l on puisse m'aider je suis un peut perdu
Tu es sur un forum, classé par sections.

Là tu veux faire un scénario, et t'alerter par SMS.
Donc section scénarios.

Ensuite, il faudrait commencer par lire la doc, ça te sera utile.
DomoPi - Mon site dédié au Raspberry Pi et à la domotique

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

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

Message par TaG » 28 juil. 2017, 17:38

Sshafi a écrit :
28 juil. 2017, 16:38
@tag : sacré programme, bon courage :-)

From Tapatruc
Merci :) ! Mais on ne peut pas bénéficier de tout comme ça, il faut aussi donner un peu de son temps ;) .

En souligné ce qui est fait !

- Micro ajout d'information sur la modale comme expliqué au dessus -> Pas si simple :) mais normalement j'ai tout bon, j'ai mis à jour dans toutes les langues :o :shock: , je ne m'y attendais pas :D, mais comme ça je comprend le fonctionnement des traductions !!!
- Création dans how-to d'un tuto sur les Pull Request GitHub en indiquant les principaux repositories
- Ajout d'une partie dans le plugin Telegram sur l'ajout de groupe, c'est souvent évoqués, elle est prête, il faut que je vois pour le fork du dossier images, car je n'ai pas encore testé de forker un dossier complet :), Lunarok est au courant, je lui ai déjà fait un PR :D
- Ajout d'un tuto sur spotify dans le plugin LMS, je le pique en partie à une personne du forum qui l'a posté sur la page XXX, faut que je la retrouve, mais j'ai vu avec Sarakha vu que le plugin est caché, il pushera de son coté ;).
- Ajout d'un tuto sur comment fournir les logs comme ça plus d'excuse !!!
- Chercher les questions les plus fréquemment posées et essayer de vulgariser les choses ou rajouter dans les docs ce qui permettrait d'avoir moins de questions rabâchées en permanence :)


Je sors mes rames et j'embête Lunarok pour github :) . je me marre :D

Avatar de l’utilisateur
guenneguez_t
Actif
Messages : 2377
Inscription : 17 oct. 2014, 09:07
Localisation : Seine Maritime

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

Message par guenneguez_t » 29 juil. 2017, 12:37

Moi j'utilise asciidocfx.
C'est plutôt sympa.
Développeur averti ;-)
Faire un don pour mes développements gratuits https://www.paypal.com/cgi-bin/webscr?c ... BA2DSQ844J

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

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

Message par TaG » 29 juil. 2017, 19:57

moi j'essaye de comprendre comment mettre à jour le fork que j'ai depuis la branche originale :)

mais c'est bien, comme ça je découvre et je comrpend, pour faire la doc ça sera plus facile

Avatar de l’utilisateur
bronche
Actif
Messages : 619
Inscription : 07 janv. 2016, 19:29
Localisation : Du côté de Lille la semaine et de Péronne le week-end...

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

Message par bronche » 23 août 2017, 15:17

TaG a écrit :
29 juil. 2017, 19:57
moi j'essaye de comprendre comment mettre à jour le fork que j'ai depuis la branche originale :)

mais c'est bien, comme ça je découvre et je comrpend, pour faire la doc ça sera plus facile
Ben moi aussi...
Le reste je pense avoir compris. J'édite les fichiers, je sais les modifier mais je tremble à chaque pull request...
Je ne comprends pas pourquoi il n'y a pas un bouton synchroniser mon fork...
J'utilise github version desktop ou github sur le site. Je ne suis pas allergique aux lignes de commandes mais si je peux éviter...
Avec le boulot que j'ai à faire, j'aimerai bine travaillé de la bonne manière.
Mes recherches sur google me coulent plutôt qu'autre chose...
Si quelqu'un a une explication claire, je prends
Amitiés
Phil
Des images jeedom maintenues et hébergées par mes soins :
https://queen.useed.fr/SB1268/owncloud/ ... RgLsFwkuR9

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

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

Message par TaG » 24 août 2017, 08:31

Hello,

j'ai du mettre un peu de coté les modifs sur github. J'avais trouvé comment faire pour resynchroniser depuis le github source. je regarde

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

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

Message par TaG » 24 août 2017, 09:13

Alors, je ne sais pas si c'est la bonne technique, mais voici ce qu'il faut faire je pense pour récupérer les informations depuis le dépot source.

Je vais prendre dans mon exemple le cas de la documentation jeedom.
J'y ai contribué petitement il y a quelques semaines. j'ai donc un fork de la documentation jeedom dans mon profil github (désolé pour les termes).

à la racine de ton github (suffit de cliquer sur l'icone en haut à gauche), tu trouveras ceci :
1 Les repos ou tu as contribués
2 Les repos que tu as dans ton profil (dans mon cas ce sont des forks d'autres repos
3 Repos documentation de Jeedom
4 Fork de la documentation jeedom suite à mon push, je l'ai donc dans mon profil github
Image

Nous allons cliquer sur le repos Documentation de mon profil (4), on arrivera la dessus :

1 On est sur mon github
2 On a l'information qu indique que l'on est sur un forked en provenance de jeedom/documentation
3 On nous informe que l'on est 6 commits derrière /en retard par rapport au dépôt jeedom
4 On clique sur Compare afin de voir ce qu'il nous manque

Image

On arrive la dessus :

1 Repos cible pour la comparaison
2 Repos source pour la comparaison (C'est chiant, il me faut l'inverse, repos source jeedom, repos cible mon repos à moi)
3 On clique donc sur ce petit lien qui va bien nous aider je pense 8-)

Image

On arrive donc ici :
1 C'est mieux
2 C'est mieux
3 On fait un pull request

Image

Sur la partie base, tu peux lire :
Image
en dessous, tu auras toutes les modifs qui sont donc sur le repos de jeedom, mais pas dans le tiens ;).

Ensuite, on arrive la dessus :

1 Le titre du Pull Request
2 Le texte du PR
3 On valide, on croise les doigts ;)

Image

on arrive la dessus :

1 on a une confirmation qui rappelle que l'on va prendre ce qui est sur jeedom pour le mettre dans taggou91, donc ça semble être dans le bon sens ;)
2 On merge !

Image

On confirme le merge :

Image



On a le merge qui est terminé :

1 ça confirme que c'est bien mergé :)
La case que j'ai entouré en rouge, permet de faire un retour arrière si on s'est loupé sur quelque chose

Image

On peut vérifier en faisant ça :

1 On clique sur notre repos
2 On voit que l'on est en "avance" par rapport au repos jeedom. Même si ce message n'est pas hyper logique selon moi, mais bon, on est normalement à égalité
Image

Si quelqu'un pouvait valider ma procédure c'est top ;)

Elle est faite en live à l'instant.

Elle fera partie des procédures qui seront mises dans la pages Github de la section How-To, mais faut que je mette plus de chose que juste cette procédure, genre, faire un fork, faire un PR depuis notre fork pour le proposé dans le repository maitre etc ;)


Dernier point sauf si un repos est autorisé par son concepteur pour avoir du merge automatique, tu ne peux pas faire un merge.
Donc le fait de faire un merge comme le montre la procédure ci-dessus, veut bien dire que tu va récupérer les données sur ton repository ;).

Exemple:
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 ;).

Voili voilou

Avatar de l’utilisateur
bronche
Actif
Messages : 619
Inscription : 07 janv. 2016, 19:29
Localisation : Du côté de Lille la semaine et de Péronne le week-end...

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

Message par bronche » 24 août 2017, 19:10

Merci
Voici une excellente explication et un très bon tuto !
Ca reste quand même vachement complexe !
Amitiés
Phil
Des images jeedom maintenues et hébergées par mes soins :
https://queen.useed.fr/SB1268/owncloud/ ... RgLsFwkuR9

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

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

Message par TaG » 24 août 2017, 22:57

Avec plaisir. Je viens de le survoler, effectivement il est long :D

ebouriffeur24
Timide
Messages : 127
Inscription : 26 déc. 2015, 21:17

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

Message par ebouriffeur24 » 29 août 2017, 23:26

Super boulot TaG ,
ça donne envie de proposer des points d’améliorations et d’apporter son petit cailloux à l’édifice.
“La théorie, c'est quand on sait tout et que rien ne fonctionne. La pratique, c'est quand tout fonctionne et que personne ne sait pourquoi. Ici, nous avons réuni théorie et pratique : Rien ne fonctionne... et personne ne sait pourquoi !”

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 : 249
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 : 1032
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 : 1032
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 : 394
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 : 2096
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: VM ProxMox sur HP Microserver N54L
Z-wave: Z-stick Aeonlabs S2
433MHz: RFXCom433E
Hue

Avatar de l’utilisateur
magicgg91
Actif
Messages : 9913
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.
DomoPi - Mon site dédié au Raspberry Pi et à la domotique

TaG
Actif
Messages : 1032
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 : 2096
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: VM ProxMox sur HP Microserver N54L
Z-wave: Z-stick Aeonlabs S2
433MHz: RFXCom433E
Hue

DJo86
Timide
Messages : 185
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 !!!

Répondre

Revenir vers « Annonces officielles »

Qui est en ligne ?

Utilisateurs parcourant ce forum : Aucun utilisateur inscrit et 4 invités