Help:Contribuer
Cette page contient des informations concernant la manière de modifier le wiki TechBase de KDE, y compris l'emplacement des contenus ainsi que des outils spécifiques adaptés à ce wiki. Même si vous êtes familier avec les wikis, vous pouvez relire la section sur l'organisation pour savoir où placer votre contenu sur ce wiki.
Avant de commencer
Les premières choses d'abord
- Pour contribuer sur TechBase vous devez déclarer un compte avec le service KDE Identity, puis l'activer sur Phabricator en vous y connectant, puis en cliquant sur le lien Se connecter avec Phabricator (Login with Phabricator) de la barre latérale pour ouvrir une session.
- Notez bien que vous devez accepter que vos contributions à ce wiki soient placées sous les licences listées sur KDE TechBase:Copyrights. Ces licences signifient que ce que vous produisez peut être par exemple, recopié vers d'autres sites.
- Utilisez les pages de discussion (Talk pages) pour communiquer avec les autres contributeurs ou pour demander de l'aide. Normalement quelqu'un vous répondra dans la journée.
Que trouve-t-on ici ?
Ce wiki concerne la documentation des développeurs voulant utiliser ou étendre les produits KDE (via les API) , ainsi que :
- les informations générales sur les bibliothèques, y compris les avantages en les utilisant
- les tutoriels et les exemples d'utilication des bibliothèques
- les tutoriels, les exemples et la documentation pour écrire des plugins et d'autres extensions aux bibliothèques et aux applications
- les interfaces IPC/RPC pour le logiciel, comme les interfaces de DBus
La documentation de l'utilisateur final est à placer dans le wiki UserBase. Les sujets relatifs aux contributeurs, aux équipes et à la communauté KDE en général sont dans le wiki de la communauté.
Exemples de ce qu'il ne faut pas mettre sur le wiki TechBase :
- la documentation sur la manière d'utiliser une application
- les règles d'écriture du code
- les informations pour les nouveaux contributeurs
- la coordination de l'équipe (listes TODO à faire, les notes des réunions, etc...)
- les notes sur l'architecture interne d'un morceau de logiciel (mais on peut mettre ici l'architecture de l'API d'une bibliothèque)
Vous pouvez lire les instructions sur community.kde.org
Organisation
| À faire : |
|---|
| besoin de documenter la structure |
La mise en page
- La page d'accueil du site MediaWiki comporte un guide de la syntaxe Wiki
- UserBase possède plusieurs listes de formats qui peuvent servir de référence, y compris les modèles spécifiques aux wikis KDE.
- Pratiquement tout ce qui couvre Wikipedia (sauf les modèles) s'applique également ici, y compris le balisage Wiki (Wiki markup) et le résumé signalétique (Wikitext Cheatsheet).
Maintenance du Wiki
Maintenir un wiki propre et utile implique de s'assurer que le contenu est à jour, que tous les liens sont encore actifs, et que toutes les pages peuvent êtres accédées (c'est à dire que chacune est appelée de quelque part). Les pages spéciales suivantes peuvent vous aider à trouver les problèmes à résoudre :
- Problèmes à résoudre en priorité
- pages orphelines
- redirections cassées
- doubles redirections
- Problèmes à résoudre ultérieurement
- pages les plus demandées
- catégories les plus demandées
Vous pouvez aussi ajouter une page à la catégorie 'requiert votre attention' (Needs Attention) pour la marquer en tant que travail à faire plus tard, en ajoutant [[Category:Needs Attention]] à la page. En utilisant Template:TODO vous ajoutez aussi cette page à la catégorie.
Supprimer des pages
La plupart des utilisateurs ne peuvent pas supprimer les pages du Wiki - ceci est dû au fait que une fois que la page a été supprimée, vous ne pouvez pas la restituer. Si vous pensez qu'une page doit être supprimée, marquez la en insérant le modèle Template:Proposed_deletion tout au début en indiquant, en anglais dans 'reason=', le motif de la supression :
{{Proposed_deletion|reason=this page contains only spam}}