Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022 | Azure DevOps Server 2020
A Git-adattárban már karbantartott tartalmakat közzéteheti egy Azure DevOps-wikin. Az adattár tartalmazhat fájlokat egy szoftverfejlesztői készlethez (SDK), termékdokumentációhoz, README-tartalomhoz stb. Több wikit is közzétehet egyetlen csapatprojekthez.
Ha a Markdown-fájlokat (.md) egy wikiben teszi közzé, számos előnnyel jár:
- Rendezd a tartalmat felügyelt oldal-sorrend struktúrába.
- A tartalomjegyzék böngészése és szűrése
- A tartalom új verzióinak közzététele
- Tartalom kezelése ugyanúgy, mint a kódbázis kezelése
- A Wikikeresés funkcióval egyszerűen kereshet a wikiben
További információ: Kiépített wiki és közzétett kód wikiként.
Ez a cikk azt ismerteti, hogyan adhat hozzá és szerkeszthet wikiben közzétett tartalmakat az Azure DevOps webes portál és az Azure DevOps CLI használatával. Offline is dolgozhat, és ugyanúgy frissítheti a wikitartalmat, mint a Git-adattárban lévő kódon. További információ: Wikilapok frissítése offline állapotban.
Előfeltételek
| Kategória | Követelmények |
|---|---|
| Projekt hozzáférés | Annak a projektnek a tagja, amelyben a wiki található. Igény szerint kérhet hozzáférést a projekt rendszergazdájától. |
| engedélyek | A Közreműködők csoport tagja. |
| Git-adattár | A csapatprojektben definiált Git-adattár. Ideális esetben az adattár legalább egy Markdown-fájlt tartalmaz, amelyet közzé szeretne tenni a wikiben. További információ: Új Git-adattár létrehozása a projektben. |
A wiki megnyitása
Csatlakozzon az Azure DevOps-projekthez egy támogatott webböngésző használatával, és válassza a Wiki lehetőséget:
Ha át kell váltania a csapatprojektet, válassza az
Azure DevOps lehetőséget az összes csapatprojekt és csapat tallózásához.
Git-adattár közzététele wikiben
Ez a szakasz bemutatja, hogyan teheti közzé a Git-adattárat egy wikiben. Közvetlenül az Azure DevOps felhasználói felületével dolgozhat a böngészőben, vagy használhatja az Azure DevOps parancssori felületét.
Ha közzé szeretné tenni a Markdown-fájlokat a Git-adattárban egy wikiben, kövesse az alábbi lépéseket:
A Wiki kezdőlapján válassza a Kód közzététele wikiként lehetőséget:
Ha nem látja a Kód közzététele wikiként lehetőséget; előfordulhat, hogy először meg kell határoznia a projekthez egy Git-adattárat. Kövesse az új Git-adattár létrehozása, a wikilap frissítése, majd az eljáráshoz való visszatérés utasításait.
Ha már rendelkezik csapatprojekt wikivel, bontsa ki a projekt legördülő menüjét, és válassza a Kód közzététele wikit:
A Kód közzététele wikiként párbeszédpanelen válassza ki a Markdown-fájlokat tartalmazó adattárat, ágat és mappát. A Git-adattárnak a csapatprojekten belül kell lennie. Ha az adattárban lévő összes Markdown-fájlt közzé szeretné tenni a wikiben, válassza ki az adattár gyökerét (
/) mappaként:
Adja meg az új wiki-adattár nevét, és válassza a Közzététel lehetőséget. A wiki-adattár feltölti a kijelölt adattárban található Markdown-fájlokat és mappákat.
Az alábbi képen az előző lépésben kiválasztott azure-docs-sdk-node adattárban található fájlok közzétett adattára látható:
A kód wikije tartalmaz egy tartalomjegyzéket (TOC):
- A TOC-cím a Markdown-fájlnévből származik.
- Az adattárban/ágban/mappában lévő Markdown-fájlok betűrendben jelennek meg.
- A közzétett mappában definiált minden almappához létrejön egy szülőlap, még akkor is, ha a mappa nem tartalmaz Markdown-fájlokat.
Az alábbi képen az azure-docs-sdk-node adattár TOC-tartalma látható:
A Git-adattár ága a wikire van leképezve
A Git-adattárág vezetője a közzétett kód wikijéhez van leképezve. Az ágon és a kijelölt mappákon végzett módosítások automatikusan megjelennek a közzétett kód wikijében. Nincs más munkafolyamat.
Feljegyzés
Közzétett kód wikinként legfeljebb 10 ágat tehet közzé.
Az extra Markdown-fájlokat tartalmazó kiépített wiki esetében ugyanúgy adhat hozzá vagy szerkeszthet oldalakat, mint a Git-adattárban lévő kódokat.
Lapok szerkesztése, átnevezése vagy törlése
Az Azure DevOps webes portálon szerkesztheti, átnevezheti vagy törölheti a wikilapokat:
A projektben válassza a Tárolók> vagy a .
A fájlok listájában válassza ki azt a lapot, amelyen dolgozni szeretne.
Válassza a Fájl További beállításai lehetőséget
, majd válassza ki a műveletet:
Feljegyzés
A wiki-adattárat ugyanúgy kezelheti, mint a többi Git-adattárat, ha a wikiben közzétételre kijelölt ág ágszabályzatait definiálja. Ha nem határoz meg ágszabályzatokat, módosításokat is végezhet, és közvetlenül az ágba küldheti őket a webportálról vagy egy ügyfélről.
A következő szakaszok részletesebben ismertetik a műveletek végrehajtását.
Lap szerkesztése
Fájl szerkesztésekor a hivatkozások segítségével megtekintheti a módosításokat, vagy kiemelheti az előző verzió módosításait.
A módosítások elvetéséhez válassza a Mégse lehetőséget. A támogatott Markdown-funkciókról további információt a Markdown-használat szintaxisával kapcsolatos útmutatóban talál.
Ha végzett, adjon hozzá egy megjegyzést a frissítésekhez, majd válassza a Véglegesítés lehetőséget:
A rendszer automatikusan megjelenít egy hivatkozást egy pull request létrehozásához. Ezt az üzenetet figyelmen kívül hagyhatja, amikor közvetlenül a wikiágat szerkeszti.
Tipp.
Ha módosítja egy fájl nevét vagy esetét, frissítse a fájlra hivatkozó .order fájlt, hogy tükrözze a módosítást. További információ: Oldalütemezés módosítása, .order fájl hozzáadása vagy frissítése.
Lap átnevezése
A wiki TOC-ban megjeleníteni kívánt lapoknak a Markdown (.md) fájltípust kell használniuk. Az Átnevezés művelet használatával átnevezhet egy fájlt, beleértve a fájlkiterjesztés módosítását is.
Az alábbi példa átnevezi a new-home-page.md fájlt New-Home-Page.md. A megfelelő oldal az "Új kezdőlap" címkével jelenik meg a wiki TOC-ban.
A lapcímek megkülönböztetik a kis- és nagybetűket, és egyedinek kell lenniük a mappában. A címnek legfeljebb 235 karakter hosszúságúnak kell lennie. További információ: Oldalcímek elnevezési korlátozásai.
Oldal törlése
Bármely Markdown-fájlt, amelyet nem szeretne megjeleníteni a wikiben, törölheti a közzétett mappából. Ha a fájlt egy .order fájlba foglalta, törölje a megfelelő oldalbejegyzést a .order fájlból. További információ: Oldalütemezés módosítása, .order fájl hozzáadása vagy frissítése.
Oldal vagy több oldal hozzáadása
A közzétett wikihöz többféleképpen adhat hozzá oldalakat:
- Fájl hozzáadása a wiki gyökérmappájába vagy bármely almappához
- Fájlok feltöltése a wiki gyökérmappájába vagy bármely almappába
- Bármely .order fájl hozzáadása vagy frissítése a wiki TOC oldalütemezésének megadásához
Minden frissítéshez véglegesítenie kell a módosításokat a wiki-adattárban. Ezután frissítse a wikit a közzétett adattárhoz a módosítások áttekintéséhez.
Lap hozzáadása a webportálról
Ha egy lapot szeretne hozzáadni a közzétett wikihöz, kövesse az alábbi lépéseket:
Az Azure DevOps webportálján menjen az Adattárak>Fájlok vagy Kód>Fájlok a közzétett adattárhoz.
Válassza a További beállítások lehetőséget
az adattárhoz, majd válassza az Új>fájl lehetőséget:
A párbeszédpanelen adja meg az új fájl nevét, amely tartalmazza a Markdown (.md) fájltípust.
A fájlnévnek meg kell egyeznie a wiki TOC-ban megjeleníteni kívánt lap címével. Cserélje le a lapcímben lévő szóközöket a fájlnévben lévő kötőjelekre (
-). A lapcímek megkülönböztetik a kis- és nagybetűket, és egyedinek kell lenniük a mappában. A címnek legfeljebb 235 karakter hosszúságúnak kell lennie. További információ: Oldalcímek elnevezési korlátozásai.Az alábbi példa egy Page-4.md nevű fájlt ad hozzá, amely a wiki TOC-ban a "4. oldal" lapcímmel jelenik meg.
Válassza a Create gombot.
Amikor megjelenik a lap a fájllistában, jelölje ki a lapot, majd válassza a Szerkesztés lehetőséget. Adja meg a lap tartalmát. További információ: Szintaxisi útmutató Markdown-fájlokhoz, widgetekhez, wikikhöz és lekéréses kérelmekhez.
Ha elkészült, adja hozzá az új lapot a közzétett adattárhoz a Véglegesítés gombra kattintva.
Fájlok feltöltése mappába
A közzétett wikiben található mappába is feltölthet fájlokat. Ez a beállítás akkor hasznos, ha meglévő tartalmat szeretne hozzáadni.
Az Azure DevOps webportálján menjen az Adattárak>Fájlok vagy Kód>Fájlok a közzétett adattárhoz.
Válassza a További beállítások lehetőséget
az adattárhoz, majd válassza a Fájl(ok) feltöltése lehetőséget:
A Véglegesítés párbeszédpanelen válassza ki a feltölteni kívánt mappát és fájlokat:
Ha elkészült, töltse fel a fájlokat a közzétett adattárba a Véglegesítés gombra kattintva.
Melléklapokat tartalmazó lap hozzáadása
Ha azt szeretné, hogy a wiki egy lapja allapokkal rendelkezzen, szüksége lesz egy azonos nevű Markdown-fájlra és mappára. A fájlnak és a mappának ugyanabban a wikimappában kell lennie.
Hozza létre az új Markdown-fájlt a Lap hozzáadása a webportálról című témakörben leírt lépésekkel.
A megfelelő mappa létrehozásához válassza a További beállítások lehetőséget
az adattárhoz, majd válassza az Új>mappa lehetőséget.Az Új mappa párbeszédpanelen adja meg a mappa nevét, amelynek meg kell egyeznie a Markdown-fájl nevével:
Válassza a Create gombot.
A wikifájllistában válassza ki az új mappát. Adjon hozzá egy vagy több fájlt aloldalként a mappához.
A .order fájl hozzáadása vagy frissítése
Miután fájlokat vagy mappákat adott hozzá a közzétett adattárhoz, az utolsó lépés az új vagy frissített mappák .order fájljának hozzáadása vagy frissítése. Frissítse az oldalütemezést, hogy az új fájlok és mappák a várt módon jelenjenek meg a wiki TOC-ban.
További információ: Oldalütemezés módosítása, .order fájl hozzáadása vagy frissítése. A .order fájlban nem szereplő fájlok a lapsorozat betűrendes listájának végére kerülnek.
Oldalütemezés módosítása .order fájllal
A wiki gyökérkönyvtárában található .order fájl megadja a lapok megjelenítési sorrendjét a gyökérszinten. A fájl a mappában található Markdown-fájloknak megfelelő lapnevek egyszerű szöveges listája, például üdvözlőprogram, támogatás, rel-2025 stb. A wiki minden mappája tartalmaz egy .order fájlt is, amely meghatározza a mappa lapütemezését.
Kövesse az alábbi lépéseket egy mappa sorrendütemezési fájljának beállításához:
A Kódfájlok > lapon válassza az Új fájl lehetőséget. Nevezze el a fájlt .order névvel.
Szerkessze a fájl tartalmát a mappában lévő Markdown-fájlok megjelenítési sorrendjének meghatározásához.
Adjon hozzá egy bejegyzést a wikifelhasználók számára láthatóvá tenni kívánt mappában lévő minden lapfájlhoz.
A lapcímek megkülönböztetik a kis- és nagybetűket. A bejegyzés szövegének meg kell egyeznie a fájlnévben használt lap címével és kisbetűivel, de ne tartalmazza a Markdown (.md) fájltípust.
Az alábbi példa egy .order fájlt mutat be egy öt fájlt tartalmazó mappához:
readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
A wiki kezdőlapjának beállítása
Amikor kiválasztja a Wikit az Azure DevOps webes portálján, megnyílik a wiki kezdőlapja.
Alapértelmezés szerint a wiki létrehozásakor hozzáadott első oldal lesz a wiki kezdőlapja. Ha a wiki több oldalból áll, az betűrendben szereplő első fájl lesz kezdőlapként beállítva.
Megadhatja, hogy melyik lapot használja kezdőlapként a .order fájlban a wikigyökérnél a lapütemezés beállításával. Helyezze a kezdőlap nevét a legfelső sorba a .order fájl gyökérben.
Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9
Mappa átalakítása wikilappá
Megjeleníthet egy mappát az adattárban lapként a wikiben. Ez a folyamat úgy ismert, mint amikor egy mappát átteszünk egy lapra.
Ebben a forgatókönyvben a következő konfigurációra van szüksége:
Egy Markdown-fájl (.md) a wikiben, amelynek neve megegyezik a mappával.
A Markdown-fájlnak és a mappának a wikifájllistában ugyanazon a helyen kell lennie.
Az alábbi példa egy Teszt nevű mappát és Markdown-fájlt (.md) mutat be. Az azonos nevű társtársak jelenléte ugyanazon a helyen létrehoz egy azonos nevű lapot a wikiütemezésben:
Wikiverzió kiválasztása
Ha a wiki több közzétett verzióval is rendelkezik, alapértelmezés szerint a legújabb verzió jelenik meg.
Másik wikiverziót az ág legördülő listájának kibontásával és a megjelenítendő verzió kiválasztásával választhat:
Kód wiki közzétételének megszüntetése
Ha már nem szeretné, hogy egy Git-adattár wikiként legyen közzétéve, megszüntetheti a wiki közzétételét.
Figyelmeztetés
Egy wiki közzétételének megszüntetése eltávolítja a teljes kód wikijét a közzétételből, ami magában foglalja az adattár összes közzétett verzióját.
A wikilistában válassza ki a közzéteendő wikit, és válassza a További beállítások (...) lehetőséget. >Wiki közzétételének megszüntetése:
Miután kiválasztotta a Közzététel megszüntetése műveletet, megnyílik egy párbeszédpanel a megerősítéshez.
A megerősítést kérő párbeszédpanelen válassza a Közzététel megszüntetése lehetőséget: