Editar el Manual¶
Es pot modificar el manual editant els documents de text localment. Aquests documents estan sincronitzats amb els que són en línia mitjançant un repositori, i en base a això el servidor actualitzarà el manual en línea.
El manual està escrit en el llenguatge de marques reStructuredText (RST) i es pot editar utilitzar un editor de text. Per veure els canvis locals, converteix (compila) el documents font del manual de RST a pagines HTML.
Actualitzar¶
Cal comprovar que la copia local del manual està actualitzada amb el respositori en línia utilitzant:
make update
Escriure¶
Es pot editar els documents de la documentació, que son els document .rst en la caperta manual, utilitzant un editor de text.
Comprovar la guia Guia d’estil d’escriptura per a convencions, i la Guia d’estils de marcat per aprendre com escriure en el llenguatge de marcatge reStructuredText.
Disfruta amb l’escriptura!
Grans canvis¶
Si es vol afegir o revisar una secció, cal assegurar-se que efectivament encara no existeix. En alguns llocs, els documents estan tan desorganitzats que les seccions poden estar duplicades o en una ubicació estranya. En el cas que trobeu una secció duplicada o fora de lloc, podeu plantear un tema (create an issue) explicant–hi el problema i, opcionalment, incloure-hi una revisió (amb canvis concrets).
Abans de fer qualsevol modificació que no sigui senzilla i clarament justificada (per exemple, moure carpetes), caldria verificar amb un responsable del manual que la vostra contribució coincideix amb la visió de la comunitat per al manual. Això garanteix el millor ús del vostre temps i bona voluntat, ja que, d’altra manera,és possible que, per algun motiu, els vostres canvis entrin en conflicte i es rebutgino és necessiti una revisió llarga. Per exemple, és possible que una altra persona ja estigui treballant a la secció que voleu canviar, que la secció estigui programada per suprimir-la o que s’actualitzi segons un canvi previst a Blender.
Comunicar aviat i amb freqüència és clau per tenir un ambient productiu, per no malgastar esforços de la gent i obtenir així un millor manual.
Obtenir Ajuda/Respostes¶
En cas de dubtes sobre la funcionalitat que voleu documentar, hauríeu de plantejar les preguntes a les desenvolupadores del Blender responsables de l’àrea o preguntar-les al canal d’assistència d’usuàries no oficial a #docs o al canal #blender-coders de Xat.
Blender disposa d’un sistema de propietaris de mòduls amb desenvolupadores i artistes com a membres que són responsables del disseny i manteniment de les àrees del Blender assignades. Consulteu les pàgines de mòduls per més informació.
Previsualitzar¶
Per veure els vostres canvis, compileu el manual segons les instruccions. Tingueu en compte que també podeu compilar només el capítol que acabeu d’editar per visualitzar-lo ràpidament. Obriu els documents .html generats dins de la carpeta build/html amb el vostre navegador web o actualitzeu la pàgina si ja la teniu oberta.
Actualitzar¶
Un cop acabats els canvis, podeu pujar-los, de manera que estaran al manual en línia. Al principi, això es fa enviant pedaços perquè algú pugui revisar els canvis i donar-vos comentaris. Després, podeu confirmar els vostres canvis directament. Aquest procés es descriu en detall a la secció següent.