Zeste de Savoir sur Fedora (pour contribuer au projet)

Bonjour à tous,

J'ai terminé la rédaction d'un tutoriel dont l'intitulé est Zeste de Savoir sur Fedora (pour contribuer au projet).

J'aimerais obtenir un maximum de retour sur celui-ci, sur le fond ainsi que sur la forme, afin de proposer en validation un texte de qualité.

Si vous êtes intéressé, cliquez ci-dessous

Informations :

Ce tutoriel reprend la documentation actuelle d'installation (https://zds-site.readthedocs.org/fr/latest/install/backend-linux-install.html) en la complétant (ajout de commandes qui sont nécessaires à l'installation de l'environnement de travail de Zeste de Savoir, explications sur certains outils…).

Il n'existait pas de tutoriel directement accessible sur le site de ZdS.

Liste des différences avec la documentation actuelle :

1. Paquets Fedora ;

2. Explications sur ce qu'est virtualenv (pourquoi il faut l'installer, et rôle des commandes) ;

3. Serveur Python de Django ;

4. Présentation brève de node.js et de son module npm ;

5. Explications concernant l'installation de ces 2 paquets (pourquoi on doit les placer dans la distro et non dans l'environnement virtuel) ;

6. Utilisation de GitHub et récupération des sources ;

7. Commande précise pour lancer la compilation des fichiers avec Gulp ;

8. Explications sur "Comment tester les modifications de code, comment accéder au site local ?" ;

9. Enfin, clairement, l'utilisateur de ma doc n'aura qu'à la lire ligne par ligne et page par page : toutes les commandes sont là, tout est carré, tout est clair je crois. L'ordre chronologique des commandes est bien effectif. Perso, avec la doc actuelle, j'ai quand même dû faire plusieurs recherches et contacter plusieurs membres de ZdS pour réussir à installer l'environnement de travail. Chose qu'il n'y aura plus besoin de faire grâce à ma doc, normalement et sauf erreur de ma part .

Merci d'avance pour votre aide

Cool, excellente initiative !

N'hésite pas a faire une pr pour mettre a jour la doc de zds sur ce qui n'est pas clair.

Super initiative

Je t'avoue que j'ai pas le temps ce weekend de lire ça convenablement, j'essayerai de le faire lundi, mais j'ai telement installé ZdS encore et encore que je devrais pouvoir être à même de faire des commentaires. De manière générale, ceci dit, n'hésite pas à utiliser ```bash pour tes lignes de console, c'est plus "joli"

Je vais faire le rabat-joie et redire ce que je disais sur IRC : Je ne vois pas l'interet d'un tuto. Ca nous ferait un énième source de doc à maintenir, qui sera tot ou tard désynchro avec la réalité du projet et donc pénible à maintenir alors que si on rajoute un fichier de doc "Installation sur Fedora" dans le dépôt (et donc Read The Docs toussa) au moins on pourra tous y participer plus directement et ca évitera le fameux risque de désynchro.

Du même avis que le caribou.

Le gros avantage d'avoir toute la documentation au même endroit (dans le dépôt versionné), c'est qu'on peut la modifier au fur et à mesure qu'on développe, et donc elle est maintenue directement pas les développeurs. Celui qui rajoute une dépendance au projet doit documenter son installation sur l'ensemble des systèmes avant de voir son code mergé.

Avec une documentation pareille sur le site, on est certain que la mise à jour se fera en décalée d'une part, et d'autre part on perd le coté central de la documentation (ce qui a déjà été reproché par les regards externes aux développement).

Je suis d'accord avec vous sur le coté décentralisé que ça va amener, MAIS !

D'un autre coté, pour moi, on a énormément de gens à qui la simple idée d'aller sur GitHub fait peur, et pour moi, un tel tutoriel aurait l'avantage de présenter les choses sur le site, "chez nous". Vous pouvez ne pas être d'accord, mais reconnaissez que ça pourrait aider à améliorer l'image du dévellopement (qui nous semble évident mais qui ne l'est pas). Alors peut-être que c'est pas la bonne solution et qu'on devrait s'y prendre autrement, mais ça peut aider, non ?

Alors dans ce cas il faut differencier "tuto pour contribuer sur ZdS" (qui est deja en cours d'ecriture d'ailleurs) et "Tuto pour installer sur Fedora" (celui ci)

Je savais pas

Et de deux, la doc et le tuto ont deux approches différentes. Comme le dit Lern-X, la doc est complète et précise, mais vachement austère. Et je suis certain qu'une PR qui rajoute un peu de "liant" à la doc se fera descendre en pièce, et pour les bonnes raisons: une doc n'est pas là pour t'expliquer ce qu'est virtualenv, pourquoi t'en a besoin et ainsi de suite (c'est un exemple, mais pandoc pourrait en être un autre). C'est par contre le rôle d'un tuto que de te prendre la main et de t'expliquer pas à pas le pourquoi du comment, ce pourquoi je trouve que la démarche est intéressante (et complémentaire à la doc, donc)

Après, ce serait dommage de se prendre la tête alors que du travail a été fourni par un membre: peut-être qu'il est possible d'intégrer des morceaux de ce tuto à celui sur "comment contribuer à ZdS", faites donc ce rencontrer les auteurs

Par contre, je suis d'accord sur le fait qu'une petite PR "installation sous Fedora" serait nécessaire (une fois encore, pour que le travail n'aie pas été fait pour rien), mais alors en respectant bien le cadre de la doc, dans ce cas.

Ouep, c'est faisable. Il suffit que je l'ajoute en tant qu'auteur pour qu'il puisse porter son tuto sur ce dernier.

Bonsoir tout le monde,

Je vais faire la PR très bientôt (normalement ce soir). Merci à Kje et à Eskimon pour leurs explications d'ailleurs

Sinon je suis parfaitement d'accord pour qu'on fasse une fusion intelligente de la doc actuellement existante et accessible ici : https://zds-site.readthedocs.org/fr/latest/index.html# et de mon tuto. Les différences que j'ai listées dans mon OP devraient nous permettre de faire cette fusion rapidement.

Pourquoi ai-je créé ce tuto ? Simplement parce que les documents qui expliquent l'installation de l'environnement de travail (par EDT j'entends le fork, le serveur et, même si c'est totalement facultatif, l'environnement virtuel Python) ne sont pas trouvables du premier coup d'oeil, alors que ça devrait être le cas. Je pense qu'en visitant la section "Tutoriels", on devrait avoir l'équivalent de la documentation tout-entière.

Ou alors il faut mettre en avant la documentation existante

Si je comprends bien, tu as entrepris la création d'un tuto qui explique comment contribuer à ZdS ? Je suis bien évidemment partant pour y participer (pas besoin de m'ajouter en tant qu'auteur, ne t'embête pas ; je vais te filer les extraits de mon tuto qu'on ne trouve pas dans la doc - (édit : ou on le fait ensemble, comme tu veux)).

Ouep, pas tout seul mais oui, il progresse très lentement cela dit. Tu as été ajouté en tant qu'auteur. Je t'invite à créer un chapitre spécifique dans la partie 2.

Ok, par contre je n'aurai pas le temps de faire ça ce soir. Ce sera pour mercredi ou jeudi (jour férié). Je m'attaque tout de suite à la PR.

T'as le temps. C'est pas comme si j'étais à deux doigts de mordre.

Bonjour tout le monde,

Je poste juste pour indiquer que j'ai annulé la demande de validation de mon tuto (comme dit plus haut, les parties intéressantes seront placées dans la doc et dans le tuto "Contribuer à ZdS").

Par ailleurs, j'ai attaqué la PR il y a quelques jours, c'est d'ailleurs pour ça que la discussion au sujet de la mise-à-jour de la doc se fait sur GitHub. Ce topic n'ayant plus vraiment d'utilité, je le marque en résolu

Bonne navigation sur le site des clémentines.

Désactivation de la beta du tutoriel Zeste de Savoir sur Fedora (pour contribuer au projet)

Pour plus d'informations envoyez moi un message privé.