Demande #5439
ouvertFinaliser la doc du service
0%
Description
Actuellement, la documentation technique du service est très incomplète :
https://admin.chapril.org/doku.php?id=admin:services:mobilizon.chapril.org
Demande : faire et finaliser la page.
Mis à jour par Baptiste Lemoine il y a plus de 3 ans
doc retapée avec les étapes pour recompiler le frontend directement sur la VM biliz
Mis à jour par Christian P. Momon il y a plus de 3 ans
- Statut changé de Résolu à En cours de traitement
Merci pour l'effort. Mais NON, en l'état, il est impossible de dire que la doc est finalisée !!!
De nombreux points nécessitent d'être revus. En voici quelques-uns :
- « copiée depuis la doc de joinmobilizon.org https://docs.joinmobilizon.org/administration/ » : lien 404 ;
- « Mobilizon nécessite entre autres Elixir, NodeJS et PostgreSQL. Préférez installer Elixir et NodeJS à partir de leurs dépôts officiels plutôt que les paquets de votre distribution. » : détailler cette étape, les lecteurs ne doivent pas inventer mais appliquer ;
- « Important L'installation des dépendances dépend du système que vous utilisez. Suivez les étapes du guide des dépendances et revenez à cette page lorsque vous aurez terminé. » : la doc doit être locale, pas externe ;
- « Sur FreeBSD » : gniiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii ?!!
- « commençons par cloner le dépôt dans un répertoire nommé live : » : quel dossier ?
- « cd en direct » : hein ?
- « sudo cp support/systemd/mobilizon.service /etc/systemd/system/ » : reformater en tant que code ;
- « sudo systemctl daemon-reload » : reformater en tant que code ;
- « sudo systemctl enable –now mobilizon.service » : reformater en tant que code ;
- « sudo journalctl -fu mobilizon.service » : reformater en tant que code ;
- « sudo cp support/nginx/mobilizon.conf /etc/nginx/sites-available » : reformater en tant que code ;
- « sudo ln -s /etc/nginx/sites-available/mobilizon.conf /etc/nginx/sites-enabled/ » : reformater en tant que code ;
- « Editez le fichier /etc/nginx/sites-available/mobilizon.conf et adaptez-le à votre propre configuration. » : oui, c'est à dire ?
- « Cryptons » : gni ?
- « sudo mkdir /var/www/certbot » : certainement pas ;
- « Voir la documentation complète pour cette commande. » : une doc qui demande d'aller voir une autre doc ?
- « Mobilizon peut utiliser les fournisseurs de connexion basés sur LDAP ou OAuth (Facebook, Google, etc.) pour aider à l'enregistrement ou à la connexion des utilisateurs » : gni ?
- « Mobilizon peut utiliser la géolocalisation » : alors mobilizon.chapril.org l'utilise ou pas ?
- « (fin de la section installation) » : utilité ?
- « Mise à jour de la version chapril mobilizon » : Chapril, Mobilizon ;
- « Voici le détail des opérations: » : un « : » pour introduire des titres de sections ?
- « Localement » : pas dans le plan d'action général et n'est-ce pas hors-sujet ?
- « disons dans le dossier /var/www/html/mobilizon » : gni ?
- « - se connecter à la VM biliz, aller dans le dossier “live”, » : énumération sortie de nul part ;
- «su mobilizon cd /srv/mobilizon.chapril.org/live git checkout chapril git pull –tags origin && git pull origin chapril » : ça fonctionne ça ?!! Recommandation de détailler ;
- « (on en a pas forcément besoin à tous les coups » : si important alors pas entre parenthèses ;
- « changer les images » : « Changer les images » ;
- « Sa branche master est notre version personnalisée. Nous la rebasons quand nécessaire par dessus la branche master de l'upstream, fournie par framagit. » : n'est-ce pas tout l'inverse ?
- « Mobilizon.chapril.org est un service permettant… » : texte non à jour ;
- « suivi de bugs » : où est rangée cette section ? Majuscule ?
- « contributions à l'upstream » : où est rangée cette section ? Majuscule ?
- plein d'autres erreurs de typo, de majuscule, de titrage…
- …
Avec tous mes encouragements.
Mis à jour par Baptiste Lemoine il y a environ 3 ans
Plein de correction faites,
des cas d'usage qui ne correspondent pas à ce qu'on fait ici ont été écartés.
Mise en forme, majs, ponctuation.
Y'avait une confusion sur ce que j'entend par "mise à jour locale", j'ai mis "
Sur votre poste de travail" pour distinguer de ce qu'on fait sur la VM biliz.
Mis à jour par Christian P. Momon il y a environ 3 ans
- Assigné à
Baptiste Lemoinesupprimé