Editar el Manual¶
Puedes modificar el manual al editar los archivos de texto locales. Estos archivos pueden sincronizarse con aquellos en línea a través de un repositorio, en base a esto el servidor actualizará el manual en línea.
The manual is written in the reStructuredText (RST) markup language and can be edited using a plain text editor. For a local preview, you convert (build) the manual source files from RST into HTML web pages.
Actualizar¶
Primero, asegúrate de que tu copia local del manual está actualizada con el repositorio en línea usando:
svn update
Escribir¶
Ahora puedes editar los archivos de la documentación, que son los archivos .rst dentro de la carpeta manual usando el editor de texto de tu preferencia.
Asegúrate de revisar Guía de Estilo de Escritura para ver las convenciones y Guía de Estilo de Marcado para aprender a escribir en el lenguaje de marcado reStructuredText.
¡Feliz escritura!
Cambios Mayores¶
Si vas a agregar o revisar una sección, asegúrate de verificar cuidadosamente de 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 encuentres algún duplicado o una sección fuera de lugar, crea una tarea explicando el problema, y opcionalmente incluye una revisión (cambios reales).
Antes de realizar cualquier edición que no sea simple y esté claramente justificada (por ejemplo, mover las carpetas), deberías verificar con un mantenedor del manual que tu contribución está de acuerdo con la visión de la comunidad para el manual. Esto asegura el mejor uso de tu tiempo y buena voluntad, ya que de otra forma es posible que, por alguna razón, tus cambios entren en conflicto y sean rechazados o necesiten revisiones que toman mucho tiempo. Por ejemplo, puede ser que otra persona ya se encuentre trabajando en la sección que deseas cambiar, la sección puede tener una fecha de eliminación o ser actualizada de acuerdo con algún cambio planificado para Blender.
Comunicarse temprano y frecuentemente es la clave para tener un entorno productivo, para no desperdiciar el esfuerzo de las personas y para lograr un mejor manual de Blender como resultado.
Obtener Ayuda/Respuestas¶
Si tienes dudas acerca de la funcionalidad que deseas documentar, deberías dejar tus 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 Blender Chat.
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. Consulta la página de propietarios de módulos para obtener más información.
Vista Previa¶
Para ver tus cambios, construye el manual como se indica en. También ten en cuenta que puedes construir sólo el capítulo que has editado para verlo rápidamente. Abre los archivos .html generados dentro de la carpeta build/html usando tu navegador web, o refresca la página si ya la tienes abierta.
Subir los cambios¶
Cuando estés contento con tus cambios, puedes 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 tus cambios y darte su opinión. Después podrás establecer tus cambios directamente. Este proceso se describe en detalle en la próxima sección.