Úpravy manuálu
Manuál môžete meniť úpravou miestnych textových súborov. Tieto súbory sa synchronizujú s tými priamo pripojenými prostredníctvom úložiska, na základe toho bude server priamym pripojením aktualizovať manuál.
Manuál je napísaný v značkovom jazyku reStructuredText (RST) a je možné ho upravovať použitím textového editora. Pre miestny náhľad konvertujete (zostavíte) zdrojové súbory príručky z RST na webové stránky HTML.
Aktualizácia
Najskôr sa ubezpečte, že vaša lokálna kópia manuálu je aktuálna s priamo pripojeným úložiskom použitím:
svn update
Písanie
Teraz môžete upravovať súbory dokumentácie, ktoré sú súbormi .rst
v priečinku manual
, použitím textového editora podľa svojho výberu.
Nezabudnite skontrolovať konvencie v Sprievodca štýlom písania a Sprievodca štýlom značiek, aby ste sa naučili písať v značkovom jazyku reStructuredText.
Veľa šťastia pri písaní!
Väčšie zmeny
Ak sa chystáte pridať alebo opraviť sekciu, nezabudnite starostlivo skontrolovať, či už neexistuje. Na niektorých miestach sú dokumenty tak neusporiadané, že časti môžu byť duplicitné alebo na nezvyčajnom mieste. V prípade, že nájdete duplikát alebo časť, ktorá nie je na mieste, vytvorte úlohu, vysvetlite problém a voliteľne vrátane revízie (aktuálne zmeny).
Pred vykonaním akýchkoľvek úprav, ktoré nie sú jednoduché a zreteľne odôvodnené (napríklad presunutie priečinkov), by ste si mali pomocou správcu príručky overiť, že váš príspevok zodpovedá predstavám komunity o príručke. Takto je zaistené čo najlepšie využitie vášho času a ochoty, pretože je možné, že z nejakého dôvodu budú vaše zmeny v konflikte a budú odmietnuté alebo si vyžadujú časovo náročnú kontrolu. Napríklad iná osoba už môže pracovať na sekcii, ktorú chcete zmeniť, môže byť naplánované odstránenie sekcie alebo aktualizácia podľa plánovanej zmeny Blenderu.
Včasná na častá komunikácia je kľúčom k vytvoreniu produktívneho prostredia, predídeniu plytvania úsilím ľudí a dosiahnutiu lepšieho manuálu Blendera.
Získanie pomoci/odpovedí
Ak máte pochybnosti o funkčnosti, ktorú chcete zdokumentovať, mali by ste svoje otázky položiť vývojárom Blenderu zodpovedným za túto oblasť alebo sa opýtať na neoficiálnom kanáli podpory užívateľov v #docs
alebo #blender-coders
kanáli v Blender Chat.
Samotný Blender má systém vlastníkov modulov s vývojárskymi a umeleckými členmi, ktorí sú zodpovední za dizajn a údržbu pridelených oblastí Blenderu. Ďalšie informácie nájdete na stránke Vlastníci modulov.
Náhľad
Ak chcete zobraziť svoje zmeny, zostavte manuál podľa pokynov. Nezabudnite, že môžete zostaviť aj iba kapitolu, ktorú ste práve upravili, aby ste si ju mohli rýchlo prezrieť. Otvorte vygenerované súbory .html
vo vnútri priečinka build/html
pomocou webového prehliadača alebo obnovte stránku, ak ju už máte otvorenú.
Načítanie
Ak ste so svojimi zmenami spokojní, môžete si ich načítať, aby boli v priamo pripojenom manuáli. Spočiatku sa to robí odoslaním opravných záplat, aby niekto mohol skontrolovať vaše zmeny a poskytnúť vám spätnú väzbu. Neskôr môžete zmeny potvrdzovať priamo. Tento proces je podrobne popísaný v nasledujúcej časti.