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 mailing list concernant des points particuliers de la ligne éditoriale.

voir les autres mini-tutoriels

Roschan propose un très bon modèle pour documenter une nouvelle application sur sa page brouillon.

N'hésitez pas à l'utiliser comme point de départ de votre documentation.

copié collé de les_modeles :

Afin de garantir l'homogénéité du wiki, essayez, pour chaque page créée ou éditée, de conformer si possible vos contributions à l'un des modèles proposés :

  • pour parler d'un logiciel, le modèle Application ;
  • pour présenter un ordinateur, le modèle Portable ;
  • pour présenter un périphérique, le modèle Matériel ;
  • pour des explications pas à pas, le modèle Tutoriel ;
  • pour lister les ressources en lien avec une thématique, le modèle Portail ;
  • pour vous présenter sur le wiki, le modèle Utilisateur.

Si la page que vous projetez ne cadre pas avec l'un des modèles proposés, il vaut mieux poser la question aux autres contributeurs que de se lancer dans une adaptation libre, surtout pour une première contribution.

APT

Si on documente en ligne de commande (pour un serveur par ex.) on renseigne apt (apt-cli) plutôt que apt-get.

Modèle

Pour installer ce logiciel, installez le paquet bidule.

Ce logiciel se trouve également dans la 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 ajout_d_un_ppa_a_vos_sources_logicielles qui affiche les avertissements de rigueur.

Modèle

Installez le paquet via le PPA du projet :

  1. ajoutez le PPA ppa:bidule/ppa1) dans vos sources de logiciels

snap

Modèle

Depuis Bionic 18.04, ce logiciel se trouve en snap dans Logiciel sous le nom Bidule.

Si vous n'utilisez pas Logiciel, vous pouvez tout de même installer Bidule sur n'importe quelle version d'Ubuntu.

AppImage

Modèle

FlatPak

Modèle

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

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ée.

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 18.04.

On indique dans les tags les versions LTS concernées par la doc, seulement par leur nom de code.

Il est recommandé d'éviter d'indiquer uniquement la ligne de commande (il vaut mieux apprendre à pêcher…), 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

  • utilisateurs/krodelabestiole/brouillon/wiki/recommandations.txt
  • Dernière modification: Le 05/09/2018, 13:31
  • par krodelabestiole