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 idioma 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:

make update

Escribiendo

Ahora será posible editar los archivos de la documentación, que son archivos .rst dentro de la carpeta manual, usando el editor de texto de preferencia.

Asegurarse de revisar Guía de estilo de escritura para las convenciones y Guía de Estilo de Marcado para aprender cómo escribir en el idioma de marcado reStructuredText.

¡Feliz escritura!

Cambios Mayores

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

Antes de realizar cualquier edición que no sea simple y esté claramente justificada (por ejemplo, mover carpetas), se deberá verificar con un mantenedor del manual que la contribución esté de acuerdo con la visión de la comunidad para el manual. Esto asegurará el mejor uso del tiempo y la buena voluntad, ya que de otra forma es posible que, por alguna razón, los cambios propuestos entren en conflicto y sean rechazados o necesiten revisiones que consumirán tiempo adicional. Por ejemplo, otra persona podría ya estar trabajando en la sección que se desea modificar, la sección podría estar programada para ser eliminada o actualizada 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 Chat.

Blender itself has a system of module owners with developer and artist members who are responsible for the design and maintenance of the assigned Blender areas. See the module pages for more information.

Previsualización

Para ver los cambios, crear el manual según las instrucciones. Tener en cuenta que también se podrá crear sólo el capítulo que acaba de ser editado, para verlo rápidamente. Abrir los archivos .html generados, dentro de la carpeta build/html usando un navegador web o actualizar la página, si ésta ya se encontrara abierta.

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.