Debian
Debian-France
Debian-Facile
Debian-fr.org
Forum-Debian.fr
Debian ?
Communautés
Vous n'êtes pas identifié(e).
L'icône rouge permet de télécharger chaque page du wiki visitée au format
PDF et la grise au format ODT →
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 Prochaine révision Les deux révisions suivantes | ||
|
atelier:atelier [22/09/2013 22:37] captnfab [Prérequis] |
atelier:atelier [03/07/2014 00:06] 127.0.0.1 modification externe |
||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| ====== Participer à la documentation du site Debian Facile.====== | ====== Participer à la documentation du site Debian Facile.====== | ||
| - | Vous voulez aider DF((Debian-Facile !)) en participant au WiKi ? Quelle bonne idée vous avez là ! :-) Voici quelques informations pour vous indiquer comment parvenir à vos fins. | + | Vous voulez aider DF((Debian-Facile !)) en participant au WiKi ? \\ |
| + | Quelle bonne idée ! :-) \\ | ||
| + | Voici quelques informations pour vous indiquer comment faire. | ||
| ===== Prérequis ===== | ===== Prérequis ===== | ||
| Ligne 11: | Ligne 13: | ||
| ==== Créer un compte et se connecter ==== | ==== Créer un compte et se connecter ==== | ||
| - | Afin de pouvoir contribuer, il vous faudra créer un compte sur le forum, si vous n'en possédez pas déjà un. Tout ajout ou modification du wiki demande d'être connecté, ce qui se fait pour l'instant de manière séparée sur le wiki et le forum, mais avec les mêmes //nom d'utilisateur// et //mot de passe//. | + | Pour contribuer, il faut auparavant être membre df inscrit sur le forum. \\ |
| + | Tout ajout ou modification des tutos implique (//pour l'instant//...) de se connecter sur le wiki par la touche ''connexion'' et d'utiliser vos //nom d'utilisateur// et //mot de passe// du forum pour vous identifier. | ||
| ===== Création et modification des pages ===== | ===== Création et modification des pages ===== | ||
| - | |||
| === Contributions et licence === | === Contributions et licence === | ||
| Ligne 22: | Ligne 24: | ||
| ==== Modifier une page existante ==== | ==== Modifier une page existante ==== | ||
| - | Avant de créer une page, il est important vérifier quelle n'existe pas déjà. Commencez par faire une petite recherche sur ce wiki. Si la page existe, vous êtes libre de la modifier afin de l'améliorer ou tout simplement de la mettre à jour. | + | Comme sur le forum, les entretiens concernant le wiki se font sur le forum au post dédié pour le tuto à modifier (sinon le créer) et surtout pas par MP, (//s'péce d'égoïstes//) que tout l'monde en profite aussi ! :-D \\ |
| + | Pour **maintenir un tuto sans modification** par d'autres contributeurs, on le signale dans la rubrique **Suivi :** de l'entête par le tag : **en-chantier**, tout simplement. :-) | ||
| - | <note important>Veuillez tout de même signaler les gros changement, comme une refonte complète de page, dans le forum à la rubrique [[http://debian-facile.org/viewforum.php?id=26 | DebianDocs(wiki) et Projet-df(git)]]. Les pages récentes du wiki disposent déjà d'un tel sujet signalé dans l'en-tête. Si aucun n'est indiqué, vous pouvez en créer un nouveau (sans oublier de l'indiquer dans l'en-tête de la page du wiki).</note> | + | Merci à tous de vos efforts pour ce wiki ! |
| - | Si la page du Wiki n'existe pas encore, il faudra la créer : | ||
| - | ==== Créer une nouvelle page dans le wiki ==== | + | Avant de créer une page dans le wiki, __afin de ne pas créer de doublon__, vérifier TOUJOURS par une petite recherche qu'elle n'existe pas déjà. \\ |
| + | Si la page existe, vous pouvez la modifier pour l'améliorer ou la mettre à jour. \\ | ||
| - | Pour créer une nouvelle page, rien de plus simple. Le dossier [[atelier:chantier:]] du wiki est là pour ça, il liste d'ailleurs les pages en cours de rédaction. Rendez-vous donc sur [[atelier:chantier:]], et créez votre tuto en remplissant son nom et en cliquant sur créer. | + | <note important>Veuillez tout de même signaler les gros changement, comme une refonte complète de page, dans le forum à la rubrique [[http://debian-facile.org/viewforum.php?id=26 | DebianDocs(wiki) et Projet-df(git)]]. \\ |
| + | Les pages récentes du wiki disposent déjà d'un tel sujet signalé dans l'en-tête. \\ | ||
| + | Si aucun n'est indiqué, vous pouvez en créer un nouveau dans cette section du forum (sans oublier de le reporter aussi dans l'en-tête **url** de la page du wiki).</note> | ||
| - | Une fois votre page terminé, veuillez signifier que votre page est prête sur le forum à la rubrique [[http://debian-facile.org/viewforum.php?id=26 | DebianDocs(wiki) et Projet-df(git)]]. Un modérateur se chargera de la placer dans l'[[arborescence]] du wiki à son emplacement définitif. | + | Si la page du Wiki n'existe pas //Taïaut//, créez-là dans le chantier ! \\ |
| + | Voir ci-dessous : | ||
| - | === Modèles de page === | + | ===== Le chantier ===== |
| - | <note important>Vous ne devez pas créer une page à partir de zéro, mais utiliser comme base l'un de ces tutos type, qui contiennent la structure de base et les méta-données nécessaires à l'organisation du wiki. | + | Pour créer une nouvelle page allez dans la page [[atelier:chantier:]] et suivez les indications qui y sont portées. |
| - | </note> | + | |
| - | Lorsque vous créez une nouvelle page, celle-ci contient déjà un modèle générique de tutos qui convient dans la plupart des cas. Cependant, pour certains logiciels, nous avons créé un modèle particularisé permettant de faire des TP pour celui-ci. Ces modèles sont listés ci-dessous et sont à copier/coller en lieu et place du modèle par défaut : | + | ===== Comment bien rédiger ===== |
| - | * [[:atelier:template-tuto|Tuto type]] (déjà présent par défaut dans le cadre de composition) | + | ==== Conseils et conventions ==== |
| - | * [[:doc:media:gimp:liste-des-tp|Tuto type pour Gimp]] (pour la création d'un nouveau tuto pour Gimp) | + | |
| - | ==== Conseils de rédaction ==== | + | La rédaction des tutos est libre bien sûr. Voici tout de même une liste de conseils qui permettront une meilleure intégration et à faciliter le suivi de votre page. |
| - | Vous êtes laissés très libre quant au style de la rédaction des tutos. Voici tout de même une liste de conseils qui permettront une meilleure intégration et un suivi facilité de votre page. | + | Lors de la rédaction : |
| - | Lors de la rédaction de votre page, | + | * faites simple et généraliste pour faciliter son adaptation aux futures versions de Debian |
| - | + | * utilisez les balises <nowiki><code> <code user> <code root> etc.</code></nowiki> | |
| - | * pensez à faire simple et généraliste pour faciliter son adaptation aux futures versions de Debian | + | * évitez surtout les redites ou documentations en doublon, //c'est une plaie infâme lors des mises à jour// ! :-P |
| - | * pensez à utiliser les balises <nowiki><code> <code user> <code root> etc.</code></nowiki> à bon escient | + | |
| - | * évitez toute redite ou documentation en doublon, c'est une plaie infâme lors des mises à jour | + | |
| Merci également de suivre les conventions suivantes : | Merci également de suivre les conventions suivantes : | ||
| * On utilise ''apt-get'' plutôt qu' ''aptitude'' autant que possible. | * On utilise ''apt-get'' plutôt qu' ''aptitude'' autant que possible. | ||
| - | * On n'utilise pas d' ''apt-url'', c'est tabou, ça tue des chatons à coup de cuillère en bois. | + | * On n'utilise pas d' ''apt-url'', c'est tabou, c'est cruel, ça tue des chatons à coup de cuillère en bois. |
| - | * On limite au maximum l'utilisation des dépôts externes, ou alors on prévient des dangers de sécurité qu'ils amènent. | + | * On limite au maximum l'utilisation des dépôts externes à Debian, ou alors on avertis fortement des dangers de sécurité qu'ils entraînent. |
| - | //N'hésitez pas à demander conseil aux modos et rédacteurs habitués !// | + | //N'hésitez pas à demander conseil sur le forum aux habitués !// |
| - | ===== Comment aider à améliorer le WiKi ===== | ||
| - | Créer une page n'est pas le seul moyen d'aider le Wiki. Plus importante encore est la tâche de maintenir les pages existantes. | + | ==== Syntaxe du wiki ==== |
| + | Les pages du wiki se rédigent en syntaxe DokuWiki. \\ | ||
| + | Consultez la page d'aide à la syntaxe et entraînez-vous ou testez vos écritures si besoin est dans le bac-à-sable. | ||
| + | |||
| + | * [[syntaxe|La syntaxe de Dokuwiki]] | ||
| + | * [[bac-a-sable | Le bac à sable pour vous entrainer à rédiger sur le Wiki]] | ||
| + | |||
| + | === Insérer une image dans le wiki === | ||
| + | |||
| + | Pour insérer une image dans le wiki, celle-ci doit impérativement être hébergée chez Debian-Facile car elle pourrait être retirée par son hébergeur à tout moment. \\ | ||
| + | Assurez-vous aussi que cette image est sous GPL3 ou +. :-? | ||
| + | |||
| + | * [[:atelier:insertion-image| Images dans le wiki]] La méthode pas à pas. | ||
| + | |||
| + | ==== Tags et retours sur le forum ==== | ||
| + | |||
| + | Pour assurer le suivi et la maintenance des tutos, nous utilisons deux canaux distincts : | ||
| + | * Un sujet dans le forum pour les annonce, commentaires, retours et suggestions. | ||
| + | * Un système de tag pour indiquer l'état du tuto aux modérateurs. | ||
| + | |||
| + | === Retour sur le forum === | ||
| + | |||
| + | L'en-tête des tutos contient la ligne suivante : | ||
| + | <nowiki> * Commentaires sur le forum : [[:url-a-changer | Lien vers le forum concernant ce tuto]]((N'hésitez pas à y faire part de vos remarques, succès, améliorations ou échecs !))</nowiki> | ||
| + | |||
| + | Elle est destinée à recevoir le lien vers le sujet du forum permettant les retours. \\ | ||
| + | Il vous revient donc de créer le sujet de votre tuto dans la section [[http://debian-facile.org/viewforum.php?id=26|DebianDocs(wiki) et Projet-df(git)]] du forum et de compléter l'url l'en-tête du tuto. | ||
| + | |||
| + | === Tags === | ||
| + | |||
| + | Pour faciliter le suivi d'un tuto, il est important de maintenir ses tags à jour. \\ | ||
| + | On place les tags d'un tuto dans l'en-tête ou juste en dessous de la ligne de titre, via la syntaxe suivante : | ||
| + | <nowiki> * Suivi : {{tag>en-chantier à-tester à-placer}}</nowiki> | ||
| + | |||
| + | S'il y a plusieurs tags, ils peuvent être listés séparés par des espaces : | ||
| + | {{tag>mon-tag1 mon-tag2 mon-tag3}} | ||
| + | |||
| + | | Pour marquer un tuto comme | rajouter le tag | | ||
| + | | À créer | ''à-créer'' | | ||
| + | | En chantier | ''en-chantier'' | | ||
| + | | À tester | ''à-tester'' | | ||
| + | | À placer | ''à-placer'' | | ||
| + | | À compléter | ''à-compléter'' | | ||
| + | | À corriger | ''à-corriger'' | | ||
| + | | Obsolète | ''obsolète'' | | ||
| + | |||
| + | Par exemple, pour un nouveau tuto, il faut veiller à ce que soit présente la ligne complète : | ||
| + | {{tag>en-chantier à-tester à-placer}} | ||
| + | |||
| + | |||
| + | |||
| + | ===== Comment aider à améliorer le WiKi ===== | ||
| + | |||
| + | Créer une page n'est pas le seul moyen d'aider le Wiki. Plus importante encore est la tâche de maintenir les pages existantes. \\ | ||
| Pour voir l'[[:atelier:qa | état du wiki, c'est ici !]] | Pour voir l'[[:atelier:qa | état du wiki, c'est ici !]] | ||
| ===== Statistiques sur le Wiki ===== | ===== Statistiques sur le Wiki ===== | ||
| Les statistiques du wiki sont (seront) accessibles ici : [[:atelier:stats]]. | Les statistiques du wiki sont (seront) accessibles ici : [[:atelier:stats]]. | ||
| + | |||
| + | ===== Arborescense ===== | ||
| + | |||
| + | Pour les curieux mais à usage des modos principalement : | ||
| + | * [[atelier:arborescence | La nouvelle arborescense du wiki expliquée pas à pas]]. | ||
