Publikování úložiště Git na wikiwebu

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

Obsah, který už máte v úložišti Git, můžete publikovat na wikiwebu. Tento obsah může být například podpora sady SDK (Software Development Kit), dokumentace k produktu nebo soubor README. Můžete také publikovat více wikiwebů v rámci jednoho týmového projektu.

Když publikujete soubory Markdownu na wikiweb, získáte následující výhody:

• Uspořádání obsahu do hierarchické struktury stránky
• Procházení a filtrování obsahu
• Publikování nových verzí obsahu
• Správa obsahu stejným způsobem, jakým spravujete základ kódu
• Snadné vyhledávání wikiwebu pomocí funkce vyhledávání wikiwebu

Další informace najdete v tématu Provisioned vs. published code as wiki.

Požadavky

• Máte týmový projekt. Pokud ho nemáte, vytvořte projekt .
• Povolte pro svůj projekt službu Azure Repos.
• V týmovém projektu máte definované úložiště Git. V ideálním případě obsahuje toto úložiště alespoň jeden soubor Markdownu, který chcete publikovat na wikiwebu. Další informace najdete v tématu Vytvoření nového úložiště Git v projektu.
• Oprávnění Přispívat k publikování kódu jako wikiwebu Ve výchozím nastavení je toto oprávnění nastavené pro členy skupiny Přispěvatelé. Každý, kdo má oprávnění přispívat do úložiště Git, může přidávat nebo upravovat stránky wikiwebu.

Otevřít wikiweb

Publikování úložiště Git na wikiwebu

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

az devops wiki create --name "My New Wiki" --type codewiki --repository MyRepo --mapped-path /wikis --version main --output table

ID                                    Name         Type
------------------------------------  -----------  --------
77abd847-31ec-45e9-8622-a190df8e5917  My New Wiki  codewiki

Úpravy, přejmenování nebo odstranění stránek

Pomocí následujících kroků upravte, přejmenujte nebo odstraňte stránku wikiwebu.

1. V projektu otevřete soubory Repos> nebo Soubory kódu.>

2. Zvolte požadovanou stránku, vyberte Akce a pak zvolte operaci.

   

Úprava stránky

Pomocí odkazů dostupných v režimu úprav můžete zobrazit náhled změn nebo zvýraznit změny provedené z předchozí verze. Pokud chcete změny zahodit, vyberte Zrušit. Další informace o podporovaných funkcích Markdownu najdete v doprovodných materiálech syntaxe pro použití Markdownu.

1. Až budete hotovi, přidejte komentář k aktualizacím a pak vyberte Potvrdit.

   

   Systém vám automaticky nabídne odkaz na vytvoření žádosti o přijetí změn. Tuto zprávu můžete ignorovat, když přímo upravujete větev wikiwebu.

   

Přejmenování stránky

Všechny stránky, které chcete zobrazit v obsahu, musí být typ .mdsouboru .

1. Výběrem možnosti Přejmenovat soubor odpovídajícím způsobem přejmenujte.

Například na následujícím obrázku přejmenujeme new-home-page.md na New-Home-Page.md. Tato stránka se zobrazí v obsahu s popiskem "Nová domovská stránka".

Názvy stránek rozlišují malá a velká písmena a musí být jedinečné v rámci složky a 235 znaků nebo méně. Další informace o jiných omezeních nadpisů najdete v tématu Omezení pojmenování názvu stránky.

Odstranění stránky

Z publikované složky můžete odstranit všechny soubory Markdownu, které nechcete zobrazovat na wikiwebu. Pokud jste soubor zahrnuli do .order souboru, odstraňte jeho položku ze .order souboru. Další informace naleznete v tématu Změna pořadí stránek, přidání nebo aktualizace souboru .order.

Přidání stránky nebo stránek

Do publikovaného wikiwebu můžete přidat následující stránky:

• Přidání souboru do kořenové složky nebo podsložky z webového portálu
• Nahrání souborů do kořenové složky nebo podsložky
• Přidání nebo aktualizace .order souboru pro určení pořadí stránek v obsahu wikiwebu

Každá aktualizace vyžaduje potvrzení změn do úložiště. Potom můžete aktualizovat wikiweb pro publikované úložiště a zkontrolovat změny.

Přidání stránky z webového portálu

1. V části Soubory úložiště>nebo Soubory kódu>pro publikované úložiště vyberte Akce a pak zvolte Soubor.

   

2. Zadejte název stránky, nezapomeňte zadat .md typ souboru. Název souboru by měl odpovídat názvu stránky, kterou chcete zobrazit v obsahu s pomlčkami místo mezer. Zadejte jedinečný název 235 znaků nebo méně. V názvech stránek se rozlišují malá a velká písmena. Další informace o jiných omezeních nadpisů najdete v tématu Omezení pojmenování názvu stránky.

   Chcete-li například přidat stránku, která se zobrazí v obsahu jako stránka 4, přidejte soubor s názvem Page-4.md.

   

3. Zadejte obsah stránky. Další informace najdete v doprovodných materiálech syntaxe pro soubory, widgety, wikiweby a komentáře k žádostem o přijetí změn.

4. Až budete hotovi, vyberte Potvrdit.

Nahrání souborů do složky

1. Pokud už máte definovaný existující obsah, můžete ho nahrát do složky. Vyberte Akce a pak zvolte Nahrát soubory.

   

2. Vyplňte formulář dialogového okna Potvrzení a vyberte složku a soubory, které chcete nahrát.

   

Přidání nadřazené stránky a podstránek

Pokud chcete přidat nadřazenou stránku, nejprve přidejte soubor Markdownu na úrovni kořenové složky a pak přidejte složku se stejným popiskem.

1. Chcete-li přidat složku, vyberte Složku a potom vyplňte formulář dialogového okna Nová složka . Zadejte alespoň jeden soubor, který odpovídá podstránce ve složce.

   

2. Do složky přidejte všechny požadované soubory jako podstránky.

Přidání nebo aktualizace souboru .order

Posledním krokem při přidávání souborů nebo složek do úložiště wikiwebu je přidání nebo aktualizace .order souboru aktualizovaných složek. Tato akce odráží posloupnost stránek, které chcete zobrazit v obsahu. Podrobnosti najdete v tématu Změna pořadí stránek, přidání nebo aktualizace souboru .order. Všechny soubory, které nejsou uvedené v .order souboru, se přidají na konec abecedního seznamu, protože jejich pořadí je nastavené na int.MaxValue.

Změna pořadí stránek, přidání nebo aktualizace souboru .order

Každý .order soubor definuje posloupnost stránek obsažených ve složce. Kořenový .order soubor určuje posloupnost stránek definovaných na úrovni kořenového adresáře. Pro každou složku .order definuje soubor posloupnost podstránek přidaných na nadřazenou stránku.

1. Soubor můžete přidat .order stejným způsobem jako jakýkoliv soubor ze stránky Soubory kódu>. Pojmenujte soubor .order.

2. Upravte obsah souboru tak, aby odrážel posloupnost souborů Markdown obsažených ve složce. Každá položka by měla zrcadlit název souboru, ale bez .md typu souboru. V názvech se rozlišují malá a velká písmena, takže položka by se měla shodovat s písmeny použitými v názvu souboru.

Příklad:

README
page-2
page-3
Page-4
Misc content

Nastavení domovské stránky

Ve výchozím nastavení je první soubor, který se zobrazí v kořenovém adresáři v abecedním pořadí, nastavený jako domovská stránka wikiwebu. Když na webovém portálu vyberete wikiweb , otevře se domovská stránka.

1. Domovskou stránku můžete změnit nastavením pořadí stránek v kořenovém .order souboru.

Zadejte například název stránky do prvního řádku.

New home page name here
page-2
page-3
Page-4
README
Misc content

Zvýšit úroveň složky na stránku

Aby složka byla také stránkou, potřebujete soubor Markdownu se stejným názvem jako složka, která je nastavená jako stejné jako složka na stejné straně. Takže složka i .md soubor se stejným názvem by měly být vedle sebe.

Jak je znázorněno v následujícím příkladu, test má složku i .md soubor, který vytvoří hierarchii ve stromu wikiwebu.

Výběr verze wikiwebu

Pokud chcete vybrat verzi wikiwebu, zvolte verzi z možností větve na stránce wikiwebu.

Zrušení publikování wikiwebu kódu

Pokud už nechcete, aby se úložiště publikovalo jako wikiweb, můžete ho zrušit.

1. Vyberte wikiweb, který chcete zrušit, otevřete místní nabídku a vyberte Zrušit publikování wikiwebu.

   

2. Potvrďte, že chcete zrušit publikování wikiwebu výběrem možnosti Zrušit publikování.

   

Související články

• Sledování stránky wikiwebu a získávání oznámení
• Zřízená vs. publikovaná wikiweb
• Aktualizace wikiwebu offline
• Doprovodné materiály k Markdownu pro wikiweby