Edición del Manual

Actualizar

Primero, asegúrese de que su copia local del manual está actualizada en relación al repositorio en línea usando:

svn update

Escribir

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

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

¡Feliz escritura!

Cambios grandes

Si vas a agregar o revisar una sección, asegúrese de verificar cuidadosamente de que no exista actualmente. En algunos lugares, la documentación está tan desorganizada que las secciones podrían estar duplicadas o en una ubicación extraña. En el caso de que encuentre algún duplicado o una sección fuera de lugar, cree una tarea explicando el problema, y opcionalmente incluya una revisión (actual changes).

Antes de realizar cualquier edición que no sea simple y claramente justificada (por ejemplo, mover las carpetas por allí), debería verificar con un mantenedor del manual que su contribución está de acuerdo con la visión de la comunidad para el manual. Esto le asegura un 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 toman mucho tiempo. Por ejemplo, puede que otra persona ya se encuentre trabajando en la sección que desea cambiar, la sección puede tener una fecha de eliminación o actualización según algún cambio acordado en Blender.

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

Obtención de Ayuda y Respuestas

Si tiene dudas sobre la funcionalidad que desea documentar, debería dejar sus preguntas a los desarrolladores de Blender responsables de dicha área o preguntar en el canal de soporte de usuarios no oficial en el canal IRC #blender .

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

Vista previa

Para ver sus cambios, compile el manual como se le indica. Tenga en mente que también puede compilar solamente el capítulo que ha editado para verlo rápidamente. Abra los archivos .html generados, dentro de la carpeta build/html usando su navegador web, o refresque la página si ya la tiene abierta.

Subir los cambios

Cuando esté contento 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. Luego de este proceso, podrá subir sus cambios directamente. Este proceso se describe en detalle en la próxima sección.