Edición en línea¶
¡Bienvenido! Esta página explicará el proceso de contribución a la documentación de Blender, mediante el flujo de trabajo en línea, existente. Tanto si se estuviera corrigiendo errores ortográficos, como si se tratara de la adición de una nueva sección a la documentación, todas las contribuciones son igualmente valiosas.
Debajo se presenta un panorama general del proceso de edición en línea.
Primeros pasos¶
Before contributing, you need an account at projects.blender.org. Click the «Sign In» button and follow the prompts to create an account if you don’t already have one.
Once logged in, you can start editing directly from your browser.
Búsqueda de la página que se desea editar¶
Navigate to the Blender Manual (docs.blender.org/manual)
and browse to the page you want to improve (make sure you are browsing under the development version (/dev)).
At the top-right of every page, you’ll find an «Edit Page» link. Clicking it will take you to the online editor at projects.blender.org.
Realización de cambios¶
After clicking «Edit this page,» you will see the current page source in a text editing area. Blender’s documentation is written using reStructuredText (RST).
Ahora será posible:
Correct typos or grammar issues.
Add missing details or improve explanations.
Truco
Review the Markup Style Guide for help with formatting.
Previsualización de los cambios¶
Currently, the online editor has limited support for previewing your changes. To ensure correctness, double-check your formatting and refer to similar existing documentation pages for guidance.
Envío de cambios¶
Luego de realizar la edición, proceder hasta el final de la página:
Proporcionar un resumen claro y conciso de los cambios en el campo de texto de descripción (p.ej: «Se corrigió una falta de ortografía en la documentación de Esculpido»).
Seleccionar «Commit Changes» (Enviar cambios).
This action will automatically guide you to create a «Pull Request» to submit your edits for review.
Solicitudes de incorporación de cambios y revisión de las mismas¶
When you commit your changes, they are sent as a pull request for review by the documentation team. Reviewers may suggest improvements or request additional changes.
Importante
Stay engaged! Watch your email or notifications on projects.blender.org to respond promptly to reviewer comments.
Once your pull request is approved, a reviewer will merge it, and your contribution will be published online.
Prácticas recomendadas¶
Mantener un foco en la edición: Un único tema por cada solicitud de incorporación.
Mensajes claros en la descripción: Escribir mensajes específicos en las solicitudes.
Responder ágilmente: Una comunicación activa permite acelerar el proceso de revisión.
Obtención de ayuda¶
En caso de que surgieran dudas acerca de un cambio específico, su formato o el flujo de trabajo, no dudar en solicitar ayuda:
Unirse al canal #documentation de Blender Chat <https://blender.chat/channel/documentation> (en inglés).
Abrir un issue en el proyecto de documentación en caso de ser necesaria una discusión más amplia al respecto o si se tratara de una pregunta compleja.
¡Gracias por ayudar a mejorar la documentación de Blender!