Development #51668
doc: document the release cycle
0%
Description
Il serait utile de mettre à jour la documentation d'authentic avec les informations sur le cycle de release afin d'éclairer les utilisateurs·rices.
Fichiers
Révisions associées
Historique
Mis à jour par Loïc Dachary il y a environ 3 ans
- Fichier 0001-doc-add-a-reference-to-the-release-cycle-51668.patch 0001-doc-add-a-reference-to-the-release-cycle-51668.patch ajouté
J'ai fait au plus simple pour éviter la redondance. Du coup la doc en anglais a un lien vers la doc en français de Publik. Je suppose que cela ne va pas trop gêner. Les utilisateurs·rices actuelles. J'ai aussi corrigé des erreurs triviales au passage, repérées en parcourant la documentation pour trouver ou il serait le plus pertinent d'inserer un lien vers le cycle de vie (et pas de release, excuse my english).
Mis à jour par Loïc Dachary il y a environ 3 ans
- Fichier 0001-doc-add-a-reference-to-the-release-cycle-51668.patch 0001-doc-add-a-reference-to-the-release-cycle-51668.patch ajouté
Et avec License: MIT.
Mis à jour par Valentin Deniaud il y a presque 3 ans
Loïc Dachary a écrit :
J'ai aussi corrigé des erreurs triviales
Merci, on est tout à fait preneurs.
Par contre je ne comprends pas le cœur du ticket, le cycle de mise à jour Publik correspond à la production de paquets .deb dans nos dépôts debian, qu'est-ce que cela a avoir avec l'installation d'authentic via pip dont parle le fichier ?
Mis à jour par Loïc Dachary il y a presque 3 ans
qu'est-ce que cela a avoir avec l'installation d'authentic via pip dont parle le fichier ?
Comme écrit dans le commentaire https://dev.entrouvert.org/issues/51668#note-2 c'est un nettoyage.
Mis à jour par Valentin Deniaud il y a presque 3 ans
Toujours pas compris, je veux bien que tu reformules (et je pense que ton lien est faux, il pointe sur « ajout de la licence MIT »).
Mis à jour par Loïc Dachary il y a presque 3 ans
- Fichier 0001-doc-add-a-reference-to-the-release-cycle-51668.patch 0001-doc-add-a-reference-to-the-release-cycle-51668.patch ajouté
Le lien était en effet faux, je voulais dire https://dev.entrouvert.org/issues/51668#note-1 qui se trouve juste au dessus et dans lequel j'ai écrit:
J'ai aussi corrigé des erreurs triviales au passage, repérées en parcourant la documentation pour trouver ou il serait le plus pertinent d'inserer un lien vers le cycle de vie (et pas de release, excuse my english).
Mais comme ça créé plus de confusion qu'autre chose et que par ailleurs il y a un conflit en raison de changements qui ont été fait depuis, j'ai mis à la poubelle les changements et gardé uniquement l'ajout d'une ligne concernant le cycle de release d'Authentic.
Mis à jour par Valentin Deniaud il y a presque 3 ans
Il n'y avait pas de confusion, ma remarque portait vraiment sur cette unique ligne.
Je pense que l'information apportée n'est pas compréhensible dans le contexte du fichier, elle ne le devient que quand on a lu le mail pointé dans la description du ticket, en fait il s'agit de savoir quand sont publiés des paquets Debian par Entr'ouvert, mais rien n'indique ça ni dans le patch ni dans la page wiki qui parle des mises à jour de notre SaaS.
Donc soit largement contextualiser l'info pour la rendre intelligible, soit se dire que la manière dont EO fait des paquets ne concerne pas le logiciel authentic.
Mis à jour par Loïc Dachary il y a presque 3 ans
Donc soit largement contextualiser l'info pour la rendre intelligible, ...
Tu touches la un problème de fond, en effet. La documentation d'Authentic est, dans l'état, assez peu intelligible de façon générale. Elle est aussi parfaitement inutile aux personnes d'Entr'Ouvert, comme en témoigne l'absence de modifications ces deux dernières années.
Elle est cependant utile comme mémo pour des personnes qui y laissent des petits morceaux de pain pour ne pas se perdre dans la forêt. Cette information sur le cycle de release d'Authentic m'est utile (car je vais l'oublier) et elle sera utile à d'autres personnes extérieures à Entr'Ouvert, je pense. Elle pourrait bien sur être améliorée comme tu le suggère, mais étant donné l'état d'abandon de la documentation en général, apporter un très grand soin à cette modification particulière n'est peut-être pas nécessaire.
Je t'invite donc à prendre mes correctifs de documentation (celui ci et d'autres à venir) dans cet esprit. Est-ce que cela te convient ?
Mis à jour par Valentin Deniaud il y a presque 3 ans
D'accord mais
Loïc Dachary a écrit :
elle sera utile à d'autres personnes extérieures à Entr'Ouvert
C'est important et dans ce cas là tel que c'est écrit, j'en doute.
Pour rendre l'affaire compréhensible à un œil extérieur j'imagine qu'il suffirait de dire « alternativement à l'installation depuis les sources, EO maintient des paquets Debian <lien vers le dépôt> qui sont mis à jour suivant le cycle décrit ici <lien vers le wiki> ».
Mis à jour par Loïc Dachary il y a presque 3 ans
- Fichier 0001-doc-add-a-reference-to-the-release-cycle-51668.patch 0001-doc-add-a-reference-to-the-release-cycle-51668.patch ajouté
Je suis désolé que ma proposition ne te convienne pas. Voici un correctif qui suit ton conseil.
Mis à jour par Loïc Dachary il y a presque 3 ans
- Fichier 0001-doc-add-a-reference-to-the-release-cycle-51668.patch 0001-doc-add-a-reference-to-the-release-cycle-51668.patch ajouté
Avec le correctif de typo.
Mis à jour par Valentin Deniaud il y a presque 3 ans
- Statut changé de Nouveau à Solution validée
Mis à jour par Valentin Deniaud il y a presque 3 ans
- Statut changé de Solution validée à Résolu (à déployer)
commit 4a9bb20c9cae8f5d280de0548c5de69a16290c1f
Author: Loïc Dachary <ldachary@easter-eggs.com>
Date: Tue May 4 12:30:00 2021 +0200
doc: add a reference to the release cycle (#51668)
License: MITMis à jour par Frédéric Péters il y a presque 3 ans
- Statut changé de Résolu (à déployer) à Solution déployée
doc: add a reference to the release cycle (#51668)
License: MIT