Ce Forum passera en lecture seule en janvier 2020
Image
Merci de vous rendre sur https://community.jeedom.com maintenant pour vos prochains postes ;)

Recherche personne pour faire de la doc sur les modules

Retrouvez les informations officielles de Jeedom (nouvelle version, nouveaux lancements, tutos...)
Anonyme
Actif
Messages : 10082
Inscription : 09 août 2014, 12:15

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

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

Contenu supprimé à la demande de son auteur

TaG
Actif
Messages : 1152
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 : 176
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 : 1152
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 : 176
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 : 1152
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 : 291
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 zwave avec :
- 3xFibaro FGR222, 1xFGK-101, 1xFGMS-001-ZW5, 1xFGS-213
- Broadlink RM PRO
- Nest
- 4xDash button
- Gateway Xiaomi 3 sondes de T°,1 capteur d'ouverture
- 3xBandeau led yeelight xiaomi
- 2xNut Find3
- 1xGH et 3xmini

Répondre

Revenir vers « Annonces officielles »

Qui est en ligne ?

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