Editando el Manual

Puede modificar el manual editando los archivos de texto locales. Estos archivos se mantienen en sincronía con aquellos en línea a través de un repositorio, en base a esto, el servidor actualizará el manual en línea.

El manual está escrito en el lenguaje de marcado reStructuredText (RST) y puede ser editado utilizando un editor de texto sin formato. Para obtener una previsualización local, convierta (construya) los archivos fuente del manual de RST a páginas web HTML.

Actualizar

En primer lugar, asegúrese de que su copia local del manual está actualizada con el repositorio en línea usando:

svn update

Escribiendo

Ahora puede editar los ficheros de la documentación, que son los archivos .rst dentro de la carpeta manual usando el editor de texto de su elección.

Asegúrese de revisar Guía de Estilo de Escritura para ver las convenciones y Guía de Estilo de Marcado para aprender cómo escribir en el lenguaje de marcado reStructuredText.

¡Feliz escritura!

Cambios Mayores

Si va a añadir o revisar una sección, asegúrese de verificar cuidadosamente que la misma no exista ya. En algunos lugares, los documentos están tan desorganizados que las secciones podrían estar duplicadas o en una ubicación extraña. En el caso de que encuentre una sección duplicada o fuera de lugar, cree una tarea explicando el problema y, opcionalmente, incluya una revisión (cambios actuales).

Antes de realizar cualquier edición que no sea simple y esté claramente justificada (por ejemplo, mover carpetas), debe verificar con un mantenedor del manual que su contribución está de acuerdo con la visión de la comunidad para el manual. Esto asegura el mejor uso de su tiempo y buena voluntad, ya que de otra forma es posible que, por alguna razón, sus cambios entren en conflicto y sean rechazados o necesiten revisiones que consumen tiempo. Por ejemplo, otra persona puede estar ya trabajando en la sección que desea modificar, la sección puede estar programada para eliminarse o actualizarse de acuerdo con algún cambio planificado en Blender.

Comunicarse temprano y frecuentemente es la clave para tener un entorno productivo, para no desperdiciar el esfuerzo de las personas y para conseguir un mejor manual de Blender como resultado.

Obtener Ayuda/Respuestas

Si tiene dudas acerca de la funcionalidad que desea documentar, debería plantear sus preguntas a los desarrolladores de Blender responsables de dicha área o preguntar en el canal de soporte de usuarios no oficial en #docs o en el canal #blender-coders, en El Chat de Blender.

Blender tiene un sistema de propietarios de módulos con miembros desarrolladores y artistas que son responsables del diseño y el mantenimiento de las áreas asignadas de Blender. Vea la página de propietarios de módulos para obtener más información.

Previsualización

To view your changes, build the manual as instructed. Keep in mind that you can also build only the chapter you just edited to view it quickly. Open the generated .html files inside the build/html folder using your web browser, or refresh the page if you have it open already.

Subir los cambios

Cuando esté satisfecho con sus cambios, puede subirlos, para que estén en el manual en línea. Al principio, esto se hace enviando parches de tal manera que alguien pueda revisar sus cambios y darle su opinión. Después podrá establecer tus cambios directamente. Este proceso se describe en detalle en la siguiente sección.