From 42f0eebdaae7bf742145da593f99bdf0a7b58431 Mon Sep 17 00:00:00 2001 From: Görcsös Zoltán Date: Tue, 4 Dec 2018 16:12:11 +0100 Subject: [PATCH] add picture reference model, reedme editorial clean up --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 74d41dc..1828ddc 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,22 @@ ## Szabályok: * A dokumentáció **kizárólag** markdown alapú! * A dokumentáció organizációja **könyvtárakra** törve történik -* A repository az MD fájlokon túl képeket tartalmazhat, melyek a markdown fájlokban hivatkozásra kerülnek. +* 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! +* 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 hívatkozások használatát + * 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 gitlabon jól nézzen ki. GFM-ről dokumentáció [itt][#gitlabmddoc] +* 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] * Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster] * Vagy egyszerűen használd a gitlab beépített markdown editorát... > # **Follow the rules!** -[#headerpic]: +[#headerpic]: +[#webvonalkodhuftp]: +[#ourgitlab]: [#gitlabmddoc]: -[#markdownmonster]: \ No newline at end of file +[#markdownmonster]: -- libgit2 0.21.2