#mainteiner: @zgorcsos

devprocdoc = Developer Process Documentation

A repository alatt vezetjük a Vrh fejlesztési folyamatainak dokumentációját.

Szabályok:

• A dokumentáció kizárólag markdown alapú!
• A dokumentáció organizációja könyvtárakra törve történik
• Az MD fájlokban használt képeket a web.vonalkod.hu ftp szerveren a fejlesztes/devprocdoc alá kell feltölteni. Az ftp elérési módja ezen a Redmine tudástár oldalon található. Az ide feltöltött fájlokat a http://web.vonalkod.hu/fejlesztes/devprocdoc/továbbiútvonal/fájlnév formában hivatkozuk a dokumentációban. Az ftp szerveren a devprocdoc repoisitory-val egyező könyvtár struktúrát kell kialakítani a devprocdoc könyvtár alatt!
• A fenti feltöltött, és az md fájlokban hivatkozott képeket a repository-hoz is hozzáadjuk!
• A diskurzus a dokumentációk tartalmáról kizárólag itt történik!
  • Használd a beépített Issue tracckert
  • A commitok megjegyzés hozzáfűzési lehetőségét
  • Továbbá az alább leírt szerkesztési szabályokat és a Merge request-ek rendszerét, az azokban végezhető kommentelési lehetőségeket
  • A kommunikációban preferáld az említések, és hivatkozások használatát
• A project open, hogy a dokumentáció a közvetlen gitlab.vonalkod.hu alatti linkkel egyszerűen meg lehessen osztani bárkivel.
• Mivel a fő megjelenítőnk a gitlab, ezért GitLab Flavored Markdown-t használunk. A cél, hogy a gitlab kiszólgálónkon jól nézzen ki. GFM-ről dokumentáció itt
• Jó offline MD szerkesztő: Markdown Monster
• Vagy egyszerűen használd a gitlab beépített markdown editorát...

Follow the rules!