Editar el manual¶
El manual es pot modificar editant els documents de text localment. Aquests documents estan sincronitzats amb els que són en línia mitjançant un repositori i serà a partir d’aquí que el servidor actualitzarà el manual en línia.
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, convertiu (compileu) el documents font del manual d’RST a pagines HTML.
Actualitzar¶
Cal comprovar que la còpia local del manual està actualitzada amb el repositori en línia mitjançant:
make update
Escriure¶
Es pot editar els documents de la documentació, que son els documents .rst de la caperta manual amb un editor de text.
Assegureu-vos de comprovar la Guia d’estil d’escriptura per estar al cas de les convencions i Guia d’estil de marcatge per aprendre com escriure en el llenguatge de marcatge reStructuredText.
Disfruteu amb l’escriptura!
Grans canvis¶
Si es vol afegir o revisar una secció, cal assegurar-se que realment encara no hi és. 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 plantejar una incidència (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, podria ser que, per algun motiu, els vostres canvis entressin en conflicte i es rebutgessin o calgués una revisió llarga. Per exemple, és possible que una altra persona ja estigui treballant amb 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ó.
Previsualització¶
Per veure els canvis, compileu el manual segons les instruccions al repecte. Tingueu present que també podeu compilar per separat 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 refresqueu la pàgina si és que ja la teniu oberta.
Actualitzar¶
Un cop acabats els canvis, podeu pujar-los perquè surtin en el manual en línia. Al principi, això es fa sotmetent pedaços perquè algú pugui revisar els canvis i fer un retorn. Després podeu sotmetre els vostres canvis directament. Aquest procés es descriu en detall a la secció següent.