Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
|
krodelabestiole:brouillon:wiki:recommandations [Le 19/06/2018, 16:15] krodelabestiole [APT] |
— (Version actuelle) | ||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| - | {{tag>wiki}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ====== Recommandations concernant le Wiki ubuntu-fr ====== | ||
| - | |||
| - | Cette page se propose de recenser différents modèles de page, et de partager les décisions prises en particulier sur la [[:wiki:liste_discussion|mailing list]] concernant des points particuliers de la ligne éditoriale. | ||
| - | |||
| - | ===== Modèle général ===== | ||
| - | |||
| - | Roschan propose un très bon modèle pour documenter une nouvelle application sur sa page [[:utilisateurs:roschan:brouillon]]. | ||
| - | |||
| - | N'hésitez pas à l'utiliser comme point de départ de votre documentation. | ||
| - | |||
| - | ===== Installation de logiciel ===== | ||
| - | |||
| - | ==== APT ==== | ||
| - | |||
| - | Si on documente en ligne de commande (pour un serveur par ex.) on renseigne [[:apt-cli|apt]] (apt-cli) plutôt que [[:apt-get]]. | ||
| - | |||
| - | === Modèle === | ||
| - | |||
| - | Pour installer ce logiciel, [[:tutoriel:comment_installer_un_paquet|installez le paquet]] **[[apt>bidule]]**. | ||
| - | |||
| - | Ce logiciel se trouve également dans la [[:gnome-software|logithèque]] sous le nom de "**Bidule**". | ||
| - | |||
| - | ==== Ajout PPA ==== | ||
| - | |||
| - | Ajouter un PPA est dangereux. Ne documentez jamais ''add-apt-repository'' directement sur la page, mais préférez un lien vers [[ppa#ajout_d_un_ppa_a_vos_sources_logicielles]] qui affiche les avertissements de rigueur. | ||
| - | |||
| - | ==== snap ==== | ||
| - | |||
| - | ==== AppImage ==== | ||
| - | |||
| - | ==== FlatPak ==== | ||
| - | |||
| - | ==== Application web ==== | ||
| - | |||
| - | Si elle existe évitez de documenter uniquement l'installation via paquet APT qui n'est souvent pas à jour. | ||
| - | |||
| - | Si l'application requiert un serveur [[:lamp]], vous pouvez suivre le modèle de la page [[:WordPress]]. | ||
| - | |||
| - | ==== autre ==== | ||
| - | |||
| - | ===== Versions ===== | ||
| - | |||
| - | On documente en priorité les deux dernières versions LTS. | ||
| - | |||
| - | La documentation spécifique à des versions qui ne sont plus supportées doit être supprimées. | ||
| - | |||
| - | On indique les versions par leur nom de code et leur numéro de version, avec un lien vers la page qui leur est dédiée, par ex. : [[:bionic|Bionic 18.04]]. | ||
| - | |||
| - | ===== Tags ===== | ||
| - | |||
| - | On indique dans tags les versions LTS concernées par la doc, seulement par leur nom de code. | ||
| - | |||
| - | ===== Lignes de commande ===== | ||
| - | |||
| - | Il est recommandé d'éviter d'indiquer uniquement la ligne de commande (il vaut mieux apprendre à pêcher que d'offrir un poisson), excepté dans certaines circonstances : | ||
| - | * restauration de l'affichage graphique (évidemment) | ||
| - | * documentation spécifiquement orientée serveur (on utilise généralement SSH, et pas d'affiche graphique) | ||
| - | * pas d'alternative graphique existante | ||
| - | |||