Hobetu eskuliburu hau¶
Eskuliburua Markdown formatuan mantentzen da docs/ direktorioan, eta MkDocs-ekin sortzen da.
Tokiko aurrebista¶
Sortu ingurune birtual bat eta instalatu dokumentazioaren menpekotasunak:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Ireki MkDocs-ek inprimatutako tokiko helbidea. Aurrebista berreraikitzen da iturburu-fitxategi bat aldatzen denean.
Baliozkotu gunea¶
Pull request bat ireki aurretik:
Eraikuntza zorrotzak falta diren nabigazio-sarreren, MkDocs-ek detektatutako esteka baliogabeen eta konfigurazio-abisuen berri ematen du.
Idazteko printzipioak¶
- Idatzi zeregin eta publiko zehatz baterako.
- Adierazi MRBS bertsioa portaera bertsioaren espezifikoa denean.
- Hobestu probatutako adibideak zerrenda zehatzen aldean.
- Inoiz ez sartu benetako kredentzialak edo erreserba datu pribatuak.
- Lotu erlazionatutako zereginak atal handiak bikoiztu beharrean.
- Eguneratu erabilgarri dauden itzulpen guztiak praktikoa denean.
Itzulpenak¶
Ingelesezko testua da erreferentzia. Itzulitako orriek bide erlatibo bera erabiltzen dute, hizkuntza-identifikatzailearen atzizkiarekin:
Itzulpen bat falta denean, guneak ingelesezko testua erakusten du. Itzulpenak kodea, ezarpen-izenak, abisuak eta estekak bere horretan mantendu behar ditu, xede-hizkuntzako terminologia natural eta finkatua erabiliz.
Eremua¶
Dokumentazio-zuhaitz honek MRBS 1.12.2 du helburu. Beranduagoko bertsio bat deskribatzen duten aldaketek ikusgai dagoen bertsio-esparrua eguneratu behar dute edo bertsio horretarako ezarritako dokumentazioan garatu behar dira.