Dokumentációs irányelvek

A QGIS dokumentációja automatikusan frissül a szerveren minden 0, 8 és 16 órakor (USA/Csendes-óceáni idő, UTC -08:00). Az aktuális állapot elérhető a https://docs.qgis.org címen.

A QGIS dokumentáció forrása GitHubon található: https://github.com/qgis/QGIS-Documentation. Nagyrészt reStructuredText (reST) szintaxissal íródott, kiegészítve néhány szkripttel a Sphinx eszközkészletből a HTML kimenet utófeldolgozása érdekében. Ezekkel az eszközökkel kapcsolatos általános információkért lásd http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html és https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

A következő fejezetek elmagyarázzák:

  • hogyan kell kezelni a dokumentáció forrásfájljait a git rendszerrel a GitHub platformon, ahol tárolva vannak.

  • hogyan kell szövegeket módosítani, képernyőmentéseket készíteni… a megfelelő módon

  • hogyan lehet a módosításokat megosztani, hogy bekerüljenek a hivatalos dokumentációba.

Ha arról keres általános információt, hogy hogyan közreműködhet a QGIS projektben, ahhoz a Legyen tagja a QGIS közösségnek oldalon talál segítséget.