Tudnivalók a wikikről, a READMES-ekről és a Markdownról

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Ha támogatni szeretné a csapatát vagy a projekt közreműködőit, a Markdown használatával gazdag formázást, táblázatokat és képeket adhat hozzá a csapatprojekthez. Markdown-formátumot használhat a csapatprojekt wikijében, az irányítópulthoz hozzáadott tartalomban, a csapatprojekt README-fájljában vagy más README-fájlban.

Wiki

A csapatprojekt wikijével oszthat meg információkat a többi csapattaggal. Ha teljesen új wikit épít ki, egy új Git-adattár tárolja a Markdown-fájlokat, képeket, mellékleteket és lapokat. Ez a wiki támogatja a tartalom és a szerkezet együttműködésen alapuló szerkesztését.

A csapatprojekt wikijében az alábbi funkciók támogatottak.

Wiki kiépítése vagy létrehozása

• Wiki létrehozása a csapatprojekthez
• Kód közzététele wikiként

Wikitartalommal végzett munka

• Wikilapok hozzáadása és szerkesztése
• A wikilap előzményeinek megtekintése és visszaállítása
• Wikitartalom klónozása és frissítése offline állapotban
• Wiki billentyűparancsok használata
• Wikitartalom^{szűrése vagy nyomtatása 1}

Feljegyzés

Előfordulhat, hogy a nyomtatási funkció nem érhető el a Firefox webböngészőben.

Wikitartalom formázása

• Markdown formátum
• HTML-címkék
• Képek beszúrása és átméretezése
• Hivatkozás munkaelemekre a következő használatával: #
• Fájlok csatolása
• Matematikai jelölés és karakterek
• Tartalomjegyzék (TOC) wikilapokhoz

Meglévő Git-adattárak közzététele wikiben

Sok csapat a Markdown használatával dokumentálja a kódot, és ezeket a fájlokat a kóddal együtt ellenőrzi. Bár a Git támogatja az ilyen dokumentáció karbantartását és felülvizsgálatát a szabványos lekéréses kérelmekkel együtt, az ilyen fájlok kihívást jelentenek a tartalom felhasználói számára.

• Az olvasóknak gyakran át kell szitálnia számos fájlt és mappát, hogy megtalálják az érdekes tartalmat.
• A tartalom nem rendelkezik szervezettel és struktúrával. Az olvasókat nem támogatja az eredendő oldalhierarchia.
• A tartalom verziószámozása nem támogatott.
• A tartalomban való keresés a kódok keresésére támaszkodik, nem pedig a tartalom keresésére optimalizált keresési felületre.

A közzétételi kód wikifunkcióként való közzétételével közzétehet egy vagy több, a csapatprojektben definiált Git-adattárat egy wikin. Ez a funkció lehetővé teszi a tartalomnak a kódbázis mellett való fenntartását, és lehetővé teszi a tartalmak szelektív közzétételét és frissítését wikire.

Jelentős különbségek vannak a csapatprojekthez kiépített wikik tartalmának kezelése és a Git-adattárból közzétett wikilapok között. További információ: Git-adattár közzététele wikiben.

Markdown

A Markdown megkönnyíti a szöveg formázását és a képek belefoglalását. A projektoldalakon lévő dokumentumokra, README-fájlokra, irányítópultokra és lekéréses kérelmekre is hivatkozhat. A Markdown használatával a következő helyeken adhat útmutatást a csapatának:

• Csapatprojekt wikije
• Kód közzététele wikiként
• Markdown hozzáadása irányítópulthoz
• Projektoldal vagy üdvözlőlapok
• ADATTÁR README-fájlok
• Lekéréses kérelmek

A támogatott szintaxisért lásd: Markdown használata az Azure DevOpsban.

LEÍRÁSOK

Minden adattárhoz vagy csapatprojekthez megadhat egy README-fájlt vagy több fájlt. A README írása a Markdownban egyszerű szöveg helyett.

Az információs lapokkal tájékoztathatja a közreműködőket arról, hogyan vehetnek részt a projektben. Vegye fontolóra az alábbi útmutatás hozzáadását:

• Projektfókusz
• Előfeltételek
• A környezet beállítása
• Tippek a projekten belüli teendőkért
• Adott fájlok célja vagy használata
• Projektspecifikus kifejezések és mozaikszavak
• Munkafolyamat-útmutató a módosítások véglegesítéséhez vagy feltöltéséhez és ágak hozzáadásához
• Projektszponzorok vagy partnerek

Íme néhány nagyszerű README, amelyek ezt a formátumot használják, és minden közönségnek szólnak referenciaként és inspirációként:

• ASP.NET Core
• Visual Studio Code
• Chakra Core