Édition du manuel¶
Vous pouvez modifier le manuel en éditant les fichiers textes locaux. Ces fichiers sont synchronisés avec ceux en ligne via un dépôt, le serveur mettra à jour le manuel en ligne.
Ce manuel est écrit dans le langage de balisage reStructuredText (RST) et peut être édité en utilisant un éditeur de texte brut. Pour une prévisualisation locale, vous convertissez (construisez) les fichiers sources RST du manuel en pages web HTML.
Mise à jour¶
Tout d’abord assurez-vous que votre copie locale du manuel est à jour avec le dépôt en ligne avec la commande suivante :
make update
Écriture¶
Vous pouvez éditer les fichiers de documentation, qui sont les fichiers .rst dans le dossier manual avec un éditeur de texte de votre choix.
Veuillez consulter le Guide de style d’écriture pour les conventions et le Guide de style de balisage pour apprendre à écrire dans le langage à balises reStructuredText.
Bonne écriture !
Des modifications plus importantes¶
Si vous êtes sur le point d’ajouter ou de réviser une section, veuillez vérifier soigneusement qu’elle n’existe pas déjà. Dans certaines parties, les docs sont si désorganisées que les sections peuvent être dupliquées ou à un emplacement étrange. Si vous trouvez une section dupliquée ou pas à sa place, créez une tâche expliquant le problème et accessoirement joignez-y une révision (modifications actuelles).
Avant toute édition qui n’est pas simple et pleinement justifiée (par exemple, déplacer des dossiers), vous devez vérifier avec un mainteneur du manuel que votre contribution s’accorde avec la vision du manuel par la communauté. Ceci garantit la meilleure utilisation de votre temps et de votre bonne volonté, étant donné qu’il est possible que, pour une raison quelconque, vos modifications soient en conflit et soient rejetées ou nécessiteront un examen chronophage. Par exemple, une autre personne pourrait être déjà en train de travailler sur la section que vous voulez modifier, la section peut être programmée pour une suppression ou une mise à jour selon une modification planifiée de Blender.
Communiquer tôt et fréquemment est la clé pour avoir un environnement productif, pour ne pas gaspiller les efforts des contributeurs et pour atteindre l’objectif du meilleur manuel de Blender.
Pour de l’aide et des réponses¶
Si vous avez un doute sur une fonctionnalité que vous voulez documenter, vous devriez poser vos questions aux développeurs de Blender en charge de ce domaine ou présenter votre demande sur le canal de support utilisateur non officiel dans le canal #docs ou #blender-coders dans Chat.
Blender a son propre système de responsables de modules avec des membres développeurs et artistes qui sont en charge de la conception et de la maintenance de domaines Blender qui leur sont assignés. Voir la page des responsables de modules pour plus d’informations.
Preview¶
Pour voir vos modifications, créez le manuel comme indiqué. Gardez à l’esprit que vous pouvez également ne construire que le chapitre que vous venez de modifier pour le voir rapidement. Ouvrez les fichiers .html générés dans le dossier build/html à l’aide de votre navigateur Web, ou actualisez la page si vous l’avez déjà ouverte.
Upload¶
Quand vous êtes satisfait de vos modifications, vous pouvez les téléverser, ainsi elles figureront dans le manuel en ligne. Au début, ceci est réalisé en soumettant des patches, ainsi quelqu’un peut réviser vos modifications et vous en donner un retour. Après, vous pourrez soumettre vos modifications directement. Cette procédure est décrite en détail dans la section suivante.