Edición del manual¶
Será posible 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 podrá ser editado utilizando un editor de texto simple. Para obtener una previsualización local, se deberán convertir (compilar) los archivos fuente del manual de RST a páginas web HTML.
Actualización¶
En primer lugar, habrá que asegurarse de que la copia local del manual esté actualizada con el repositorio en línea usando:
make update
Escritura¶
Ahora será posible editar los archivos de la documentación (los archivos .rst dentro de la carpeta manual) usando un editor de texto de preferencia.
Asegurarse de revisar la Guía de estilo de escritura para conocer las convenciones y la Guía de estilo de marcado para aprender cómo escribir en el lenguaje de marcado reStructuredText.
¡Feliz escritura!
Cambios de envergadura¶
Al agregar o revisar una sección, asegurarse de verificar cuidadosamente que no existiera ya. En algunos lugares, la documentación está tan desorganizada que es posible que las secciones pudieran estar duplicadas o en una ubicación poco común. En el caso de que se encontrara una sección duplicada o fuera de lugar, crear un nuevo incidente explicando el problema y, opcionalmente, incluir una revisión (los propios cambios).
Antes de realizar cualquier edición que no sea simple y estando plenamente justificada (por ejemplo, mover carpetas), se deberá verificar con uno de los encargados del manual, que la contribución esté de acuerdo con la visión de la comunidad para el manual. Esto asegurará un mejor uso del tiempo y la buena voluntad, ya que de otra forma es posible que, por alguna razón, los cambios propuestos entraran en conflicto y fueran rechazados o necesitaran revisiones que consumirían tiempo adicional. Por ejemplo, otra persona podría ya estar trabajando en la misma sección que se desea modificar o la sección podría estar programada para ser eliminada o actualizada de acuerdo con algún cambio ya planificado en Blender.
Comunicarse rápido y frecuentemente es la clave para tener un entorno productivo, para no desperdiciar el esfuerzo de las personas y para conseguir, como resultado de esto, un mejor manual de Blender.
Obtención de ayuda y respuestas¶
Si surgieran dudas acerca de la funcionalidad que se desea documentar, se deberían enviar las preguntas pertinentes 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 Conversar.
Blender tiene un sistema de propietarios para cada módulo, con miembros (tanto desarrolladores como artistas) que son responsables del diseño y el mantenimiento de las áreas asignadas de Blender. Ver la página de propietarios de módulos para obtener más información.
Previsualización¶
Para ver los cambios, compilar el manual según las instrucciones. Tener en cuenta que también se podrá compilar 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.
Enviar los cambios¶
Cuando se esté satisfecho con los cambios, podrán ser enviados, para que estén en el manual en línea. Al principio, esto se hará enviando parches de tal manera que alguien pueda revisar los cambios y dar su opinión. Más adelante será posible enviar directamente los cambios. Este proceso se describe en detalle en la siguiente sección.