Édition en ligne

Bienvenue! Cette page explique le processus de contribution à la documentation de Blender par le biais de notre flux de travail d’édition en ligne. Que vous corrigiez des fautes de frappe ou que vous ajoutiez des sections entièrement nouvelles, vos contributions sont précieuses.

Vous trouverez ci-dessous un aperçu du processus d’édition en ligne.

Prise en main

Avant de contriuer, vous devez ouvrir un compte vers projects.blender.org. Cliquez sur le bouton “Sign In” (connecter) et suivez les instructions pour créer un compte si vous n’en avez pas déjà un.

Une fois connecté, vous pouvez commencer à éditer directement depuis votre navigateur.

Trouver la page à modifier

Naviguez jusqu’au manuel de Blender (docs.blender.org/manual) et naviguez jusqu’à la page que vous souhaitez améliorer (assurez-vous que vous naviguez sous la version de développement (/dev)).

En haut à droite de chaque page, vous trouverez un lien “Edit Page”. En cliquant dessus, vous accéderez à l’éditeur en ligne de projects.blender.org.

Effectuer des modifications

Après avoir cliqué sur “Edit this page”, vous verrez la source actuelle de la page dans une zone d’édition de texte. La documentation de Blender est écrite à l’aide de reStructuredText (RST).

Vous pouvez maintenant

  • Corriger des fautes de frappe ou des problèmes de grammaire.

  • Ajouter des détails manquants ou améliorer les explications.

Astuce

Consultez le Guide de style de balisage pour obtenir de l’aide sur la mise en forme.

Aperçu de vos modifications

Actuellement, l’éditeur en ligne ne prend pas en charge la prévisualisation de vos modifications. Pour garantir l’exactitude, vérifiez votre formatage et reportez-vous aux pages de documentation existantes similaires pour obtenir des conseils.

Committer vos modifications

Après avoir effectué vos modifications, passez au bas de la page :

  • Fournissez un résumé clair et concis de vos modifications dans la boîte de message de commit (par exemple, “Correction d’une faute de frappe dans la documentation de Sculpting”).

  • Sélectionnez “Commit Changes”.

Cette action vous guidera automatiquement dans la création d’une “Pull Request” pour soumettre vos modifications à la révision.

Pull Requests et Révisions

Lorsque vous commitez vos modifications, elles sont envoyées sous forme de pull request de révision par l’équipe de documentation. Les réviseurs peuvent suggérer des améliorations ou demander des modifications supplémentaires.

Important

Restez engagés! Surveillez vos e-mails ou vos notifications sur projects.blender.org pour répondre rapidement aux commentaires des évaluateurs.

Une fois votre demande approuvée, un réviseur la fusionnera et votre contribution sera publiée en ligne.

Bonnes pratiques

  • Gardez les modifications ciblées : un sujet par pull request.

  • Effacez les messages de commit : Rendez vos messages de commit spécifiques.

  • Répondez rapidement : La communication active accélère les révisions.

Obtenir de l’aide

Si vous n’êtes pas sûr d’un changement, d’un formatage ou d’un flux de travail, n’hésitez pas à poser des questions :

Merci d’aider à améliorer la documentation de Blender!