Comment participer et améliorer cette documentation ?

La documentation du site Ubuntu-fr est publiée sous forme de wiki, un système de rédaction ouvert et collaboratif que chacun est libre de modifier. Elle est la principale source d'information française concernant Ubuntu. Si vous êtes un bon pédagogue, aidez à l'améliorer en écrivant, en complétant, en corrigeant ou en traduisant des articles.
Tout le monde peut y participer : la modification¹⁾ d'articles ne nécessite pas d'inscription.
Que vous souhaitiez commencer un texte à partir de rien, corriger des « fôts daurthograf » ou simplifier des phrases, votre contribution est la bienvenue.

Voici différentes façons de présenter à titre indicatif les bases éthiques sur lesquelles reposent les mécanismes techniques du site ubuntu-fr.org et plus précisément de cette documentation :

• Un code de conduite (issu du site anglais) est induit par les principes d'Ubuntu qui se rattachent notamment à la philosophie du même nom (voir aussi l'article « Ubuntu (idéologie) » sur Wikipédia et une vidéo représentant ce concept, également présente dans la distribution Ubuntu).
• Il ressort également de l'expérience commune quelques principes élémentaires relatifs à la documentation sous forme wiki :
  • Rester aussi simple que possible : cette notice a comme ambition de pouvoir s'adresser à tous.
  • Distinguer les faits : ce sont eux qui vont aider l'utilisateur. Un choix, une préférence ou une recommandation sont du domaine des avis. Pour obtenir un fait, il faut préciser selon qui.
  • Commencer par la base : ce qui est évident est important. C'est la première marche indispensable pour les plus novices mais aussi ce qui permet d'organiser facilement les choses plus complexes.
• Cette documentation peut aussi être représentée par des métaphores (pour imager autrement les principes précédents) :
  • c'est un pense bête communautaire : il doit permettre à chacun de retrouver ce qui est utile pour lui, sans gêner ce qui est utile pour les autres ;
  • c'est aussi un bagage pour un voyage vers l'inconnu : les choses les plus utiles doivent rester les plus accessibles, mais il faut aussi prévoir de faire face à des situations qu'on ne connaît pas encore.
• Utiliser les modèles et suivre les conseils de cette page !

La réunion 2006 no. 3 a déterminé la procédure de modification des pages existantes. Il a donc été décidé d'autoriser l'accès en écriture aux documentations, leur modification immédiate est autorisée, en parallèle l'abonnement des pages rendu possible averti immédiatement de toutes les modifications des pages auxquels certains contributeurs sont inscrits.

La documentation d'Ubuntu-fr n'est peut-être pas toujours tout à fait claire, et c'est bien normal. Elle est en constante évolution et rédigée sur une base volontaire. La meilleure façon de la voir devenir meilleure est de la critiquer (de manière constructive) et d'informer de ses observations !

Les plus téméraires voudront peut-être aussi s'abonner à la liste de diffusion des contributeurs du wiki (Coordination Wiki). Ils pourront ainsi discuter par courriel avec plusieurs contributeurs du wiki, leur présenter quels articles ils jugent difficiles et qui mériteraient une refonte. Bref, travailler en coopération avec ceux-là mêmes qui rédigent la documentation !

À défaut de modifier la page concernée, vous pouvez toujours faire part de vos critiques directement aux contributeurs. Ainsi beaucoup d'articles sont signés par leur(s) auteur(s), en bas d'article (voir la liste des utilisateurs). Vous pouvez donc cliquer dessus pour accéder à leur pages utilisateurs pour avoir des renseignements sur la façon de les contacter. Ainsi, n'oubliez pas d'expliquer la page qui devrait être retravaillée dans telle section car ceci ou cela est obscur et de dire en quoi cela est obscur, c'est un moyen efficace pour voir ses remarques prises en compte et de voir apportées des modifications à l'article.

Si une page vous intéresse que vous souhaitez suivre dans son évolution ou simplement surveiller contre le vandalisme, vous pouvez vous y abonner. Il faut cependant être inscrit sur le forum Ubuntu puis se connecter sur la documentation avec le même identifiant.

Pour vous désabonner, rendez-vous sur la page ou la catégorie à laquelle vous êtes abonné et cliquez sur « Se désabonner de la page » ou « Se désabonner de la catégorie ».

Enfin, il est toujours possible de créer un fil de discussion dans le forum à propos d'un article précis. Quelques-uns des contributeurs au wiki passent aussi dans le forum, mais pas tous. Néanmoins, un fil de discussion aura le mérite d'attirer l'attention de personnes moins connaisseuses, de celles-là mêmes qui vont utiliser le wiki qui pourront réagir aux propositions, et peut-être aussi de futurs contributeurs ? Mais comme nous l'avons mentionné, tous les contributeurs ne passent pas dans le forum, donc il faudra aussi penser à les contacter pour qu'ils puissent appliquer les modifications nécessaires si personne ne s'en charge.²⁾

Il suffit de cliquer sur « Éditer cette page » (dans l'encart Actions en haut à gauche) pour avoir la possibilité de modifier une page existante.

Le bouton « Aperçu » permet de visualiser les changements et permet de les retrouver (depuis son ordinateur seulement si pas connecté, sinon depuis tous les ordinateurs).

Le bouton « Enregistrer » sauve la modification (sur le serveur) et la rend accessible à tous.

Pour se familiariser avec ce système, la page bac à sable permet de faire des essais sans aucun risque.

Toutes les modifications que vous apporterez à la documentation font partie d'un des trois types ci-dessous.

Pour corriger des fautes d'orthographe, des liens ou toute autre coquille et, d'une manière générale, pour les améliorations de la forme plutôt que du fond, le fait de remplir la section « Résumé » en bas de la zone de modification permet de décrire rapidement le genre de contribution à l'intention des autres contributeurs.

Cette pratique est appréciée car elle facilite grandement l'utilisation de l'historique.

En cas de refonte d'articles, d'ajout ou de suppression de passages ou plus généralement de modifications changeant grandement le sens du document, l'équipe qui gère cette documentation souhaite en être informée par l'intermédiaire de la la liste de discussion de la documentation. Ce type d'envoi nécessite une inscription préalable sur son portail. Cela permet aux utilisateurs de cette liste d'intervenir plus rapidement pour ajouter les logiques d'uniformisation, pour corriger les éventuelles erreurs, etc.

Pour pouvoir créer une page, il est préférable d'être connecté en tant que membre de ce site (il s'agit du même compte que pour le forum, pour s'inscrire, c'est ici). Comme c'est aussi une intervention importante, l'équipe qui gère le wiki souhaite également en être informée par l'intermédiaire de la liste de discussion de la documentation, d'autres contributeurs plus expérimentés vous aideront à finaliser la page.

Pour créer une page dans la documentation, vous devez être de préférence connecté en tant que membre de ce site. Il s'agit du même compte que pour le forum, si vous n'en avez pas, vous pouvez en créer un ici.

Une fois connecté, allez à l'adresse que vous souhaiteriez pour votre future page, par exemple : http://doc.ubuntu-fr.org/ma_page

Si cette page n'existe pas encore, l'option « Créer cette page » apparaît dans l'onglet Actions, sur la gauche. Cliquez dessus et c'est parti !

En cas de création d'une page, il existe des modèles standardisés, veuillez vous y référer.

Il existe essentiellement trois types d'articles sur le wiki, détaillés ci-dessous.

Leur but est d'expliquer et présenter une application, un logiciel (software). Il existe un modèle pour ce type d'articles. Les pages application sont placées à la racine du wiki.

→ Modèle « application »

Leur but est d'expliquer comment faire fonctionner un matériel particulier sous Ubuntu. Il existe un modèle pour ce type d'articles ainsi qu'un modèle spécifique pour les portables. Veillez à être le plus généraliste possible (par exemple, un modem PPPoE s'installe de la même manière pour tous les fournisseurs d'accès : il n'est pas nécessaire d'écrire une nouvelle page pour Free, Skynet, Alice, etc.). Les pages matériel doivent comporter le tag « matériel » et sont placées à la racine du wiki.

→ Modèle « matériel »

→ Modèle « portable »

Ils se proposent de résoudre une problématique et utilisent généralement plusieurs applications (exemple : Comment compiler un noyau sur mesure ?). Les tutoriels n'ont pas vraiment de modèle ; veillez cependant à mentionner les versions d'Ubuntu pour lesquelles il est écrit. Les tutoriels doivent comporter le tag « tutoriel » et sont placés dans le sous-dossier « tutoriel ».

Afin d'alléger la documentation, il est demandé aux contributeurs de ne pas expliciter directement dans la page certaines actions souvent invoquées. À la place, il est renvoyé à des « mini-tutoriels » grâce à des liens. La liste des actions en question et les liens à utiliser sont explicités dans les sections suivantes.

Voir Syntaxe

Si vous comptez participer régulièrement au wiki, vous êtes invités à créer une page utilisateur. Vous pourrez vous présenter et donner un moyen de vous contacter. Si vous aviez besoin de créer une page temporaire, vous pourriez la placer dans votre répertoire ainsi créé.

Faites vos essais dans le bac à sable.

Si vous avez l'intention de recopier ou traduire un article ou une partie d'article d'un autre site vérifier certains points :

• Il est nécessaire de vérifier la licence sous laquelle cet article est placé et en conséquence si elle vous autorise à l'utiliser. À défaut contacter l'auteur par un petit courriel.
• Il vous faudra indiquer la licence elle-même, la provenance et l'auteur de l'article original.

Sinon :

• Si la licence ne le permet pas la modification sera illégale, et sera donc supprimé rapidement.

Dans tous les cas, avertissez l'auteur de l'article en question.

Lorsque vous éditez une page, l'utilisation du bouton Aperçu permet de sauver régulièrement les modifications apportées et évite de les perdre en cas de plantage sans avoir recours au bouton Sauver. Il crée un brouillon récupérable sans difficulté en cas de besoin.

De plus, de trop nombreuses sauvegardes surchargent la page « Anciennes révisions » de chaque page et la boîte aux lettres de ceux qui reçoivent un courriel à chaque sauvegarde (ceux qui sont abonnés aux modifications).

Chaque page doit être référencée avec au moins un tag (mot-clé). Mais n'en abusez pas : trop de tags est contre-productif. Inspirez-vous des tags présents dans les modèles de pages application et matériel et essayez de vous limiter à ceux déjà existants (voir la liste des tags). Et n'oubliez pas que la règle, c'est de mettre les accents dans les tags au singulier (matériel et non materiels par exemple).

Comme dans tout ce qui a trait à Ubuntu, inspirez-vous de son code de conduite.

Chaque contributeur principal d'une page devrait s'abonner aux modifications de cette page afin de les suivre.

Pour cela, il suffit de cliquer sur le bouton « S'abonner à la page » dans le menu « Actions » à gauche. L'abonné recevra alors par courrier électronique un résumé des modifications effectuées sur la page en question.

Vous pouvez commencer par modifier certaines pages, notamment sur la page des chantiers en cours pour ceux qui veulent aider mais qui sont en manque d'inspiration.

Vous pouvez aussi vous amuser sur la page playground, littéralement la salle de jeu, avec des exemples de mise en forme.

Ou alors aider les aides à la traduction.

En cas de doute, en cas de problème : contactez un coordinateur ! Ils sont accessibles par courriel : Ner0lph, YoBoY, et YannUbuntu.

Une liste de discussion (appelée également mailing-list en anglais) est disponible pour les contributeurs du wiki. Il est recommandé de s'y inscrire et d'y annoncer ses modifications importantes.

Plus d'informations sur cette page.

• Pour rédiger des articles, on utilise la syntaxe DokuWiki : voir la syntaxe. (page dokuwiki expliquant la syntaxe)
• Les modèles : application,matériel, portable, tutoriel, utilisateur.
• Pour ajouter des images dans le wiki.