Commit 42f0eebdaae7bf742145da593f99bdf0a7b58431
1 parent
5258c5e3
add picture reference model, reedme editorial clean up
Showing
1 changed file
with
8 additions
and
5 deletions
Show diff stats
README.md
| @@ -8,19 +8,22 @@ | @@ -8,19 +8,22 @@ | ||
| 8 | ## Szabályok: | 8 | ## Szabályok: |
| 9 | * A dokumentáció **kizárólag** markdown alapú! | 9 | * A dokumentáció **kizárólag** markdown alapú! |
| 10 | * A dokumentáció organizációja **könyvtárakra** törve történik | 10 | * A dokumentáció organizációja **könyvtárakra** törve történik |
| 11 | -* A repository az MD fájlokon túl képeket tartalmazhat, melyek a markdown fájlokban hivatkozásra kerülnek. | 11 | +* 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][#webvonalkodhuftp] 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! |
| 12 | +* A fenti feltöltött, és az md fájlokban hivatkozott képeket a repository-hoz is hozzáadjuk! | ||
| 12 | * A diskurzus a dokumentációk tartalmáról **kizárólag** itt történik! | 13 | * A diskurzus a dokumentációk tartalmáról **kizárólag** itt történik! |
| 13 | * Használd a beépített **Issue tracckert** | 14 | * Használd a beépített **Issue tracckert** |
| 14 | * A **commitok** megjegyzés hozzáfűzési lehetőségét | 15 | * A **commitok** megjegyzés hozzáfűzési lehetőségét |
| 15 | * 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 | 16 | * 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 |
| 16 | - * A kommunikációban preferáld az említések, és hívatkozások használatát | 17 | + * A kommunikációban preferáld az említések, és hivatkozások használatát |
| 17 | * A project open, hogy a dokumentáció a közvetlen gitlab.vonalkod.hu alatti linkkel egyszerűen meg lehessen osztani **bárkivel**. | 18 | * A project open, hogy a dokumentáció a közvetlen gitlab.vonalkod.hu alatti linkkel egyszerűen meg lehessen osztani **bárkivel**. |
| 18 | -* Mivel a fő megjelenítőnk a gitlab, ezért *GitLab Flavored Markdown*-t használunk. A cél, hogy a gitlabon jól nézzen ki. GFM-ről dokumentáció [itt][#gitlabmddoc] | 19 | +* 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][#ourgitlab] jól nézzen ki. GFM-ről dokumentáció [itt][#gitlabmddoc] |
| 19 | * Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster] | 20 | * Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster] |
| 20 | * Vagy egyszerűen használd a gitlab beépített markdown editorát... | 21 | * Vagy egyszerűen használd a gitlab beépített markdown editorát... |
| 21 | 22 | ||
| 22 | > # **Follow the rules!** | 23 | > # **Follow the rules!** |
| 23 | 24 | ||
| 24 | -[#headerpic]: <http://gitlab.vonalkod.hu:443/uploads/project/avatar/193/rules.png> | 25 | +[#headerpic]: <http://web.vonalkod.hu/fejlesztes/devprocdoc/rules.png> |
| 26 | +[#webvonalkodhuftp]:<http://redmine.vonalkod.hu/projects/vrhfejlesztes/wiki/Bels%C5%91_h%C3%A1l%C3%B3zat#VRH-infrastrukt%C3%BAra-WebSzolg%C3%A1ltat%C3%A1sok-elr%C3%A9%C3%A9sei> | ||
| 27 | +[#ourgitlab]:<http://gitlab.vonalkod.hu:443/vrh/devprocdoc> | ||
| 25 | [#gitlabmddoc]: <https://gitlab.com/help/user/markdown> | 28 | [#gitlabmddoc]: <https://gitlab.com/help/user/markdown> |
| 26 | -[#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx> | ||
| 27 | \ No newline at end of file | 29 | \ No newline at end of file |
| 30 | +[#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx> |