Přispívání do dokumentace k HoloLens
Vítá vás dokumentace HoloLens! Všechny články, které v tomto úložišti vytvoříte nebo upravíte, budou viditelné veřejnosti.
Dokumentace k HoloLensu je publikovaná v Microsoft Learn, která používá Markdown s funkcemi Markdigu pro GitHub. Obsah, který v tomto úložišti upravujete, se naformátuje na stylizované stránky, které se zobrazují v /hololens
.
Tato stránka popisuje základní kroky a pokyny pro přispívání a odkazy na základy Markdownu. Děkujeme za váš příspěvek!
Název úložiště | Adresa URL |
---|---|
HoloLens | MicrosoftDocs/HoloLens |
Hybridní realita | MicrosoftDocs/mixed-reality |
Průvodce nadšenci vr | MicrosoftDocs/mixed-reality/enthusiast-guide |
Pokud ho ještě nemáte, budete muset vytvořit účet GitHub.
Poznámka
Pokud jste zaměstnancem Microsoftu, propojte svůj účet GitHub s aliasem Microsoftu na portálu Microsoft Open Source. Připojte se k
Při nastavování účtu GitHub doporučujeme také tato bezpečnostní opatření:
- Vytvořte silné heslo pro váš účet GitHub.
- Povolte dvoufaktorové ověřování.
- Uložte kódy pro obnovení na bezpečném místě.
- Aktualizujte nastavení veřejného profilu .
- Nastavte své jméno a zvažte nastavení veřejné e-mailové na Nezobrazovat moji e-mailovou adresu.
- Doporučujeme nahrát profilový obrázek, protože miniatura se zobrazuje v článcích Microsoft Learn, do které přispíváte.
- Pokud plánujete používat příkazový řádek, zvažte nastavení Správce přihlašovacích údajů Gitu pro Windows. Tímto způsobem nebudete muset zadávat heslo pokaždé, když uděláte příspěvek.
Systém publikování je svázaný s GitHubem, takže tyto kroky jsou důležité. Každý článek bude uvedený jako autor nebo přispěvatel pomocí aliasu GitHubu.
Pomocí následujícího pracovního postupu proveďte aktualizace existujícího článku přes GitHub ve webovém prohlížeči:
Přejděte do článku, který chcete upravit ve složce hololens.
V pravém horním rohu vyberte tlačítko pro úpravy (ikona tužky).
Tím se automaticky rozvětvení uvolnitelné větve z výchozí větve hlavní.
Upravte obsah článku podle základního Markdownu.
Aktualizujte metadata v horní části každého článku:
- nadpis: Název stránky, který se zobrazí na kartě prohlížeče při prohlížení článku. Názvy stránek se používají pro SEO a indexování, takže název neměňte, pokud není potřeba (i když je to méně důležité před zveřejněním dokumentace).
- popis: Napište stručný popis obsahu článku, který zvyšuje SEO a zjišťování.
- autor: Pokud jste primárním vlastníkem stránky, přidejte sem svůj alias GitHubu.
- ms.author: Pokud jste primárním vlastníkem stránky, přidejte sem svůj alias Microsoftu (nepotřebujete @microsoft.com, jenom alias).
- ms.date: Aktualizujte datum, pokud na stránku přidáváte hlavní obsah, ale ne pro opravy, jako je objasnění, formátování, gramatika nebo pravopis.
- klíčová slova: Pomoc s klíčovými slovy v SEO (optimalizace vyhledávacího webu). Přidejte klíčová slova oddělená čárkou a mezerou, která jsou specifická pro váš článek, ale za poslední klíčové slovo v seznamu není interpunkce. Nemusíte přidávat globální klíčová slova, která platí pro všechny články, protože se spravují jinde.
Po dokončení úprav článku se posuňte dolů a vyberte Navrhnout změnu souboru.
Na další stránce vyberte Vytvořit žádost o přijetí změn, sloučit automaticky vytvořenou větev do výchozí větve hlavní.
Opakujte výše uvedené kroky pro další článek, který chcete upravit.
Pokud vaše změna přejmenuje nebo odstraní existující článek, nezapomeňte přidat přesměrování. Každý, kdo má odkaz na existující článek, tak skončí na správném místě. Přesměrování spravuje .openpublishing.redirection.json soubor v kořenovém adresáři úložiště.
Pokud chcete přidat přesměrování na .openpublishing.redirection.json, přidejte do pole redirections
položku:
{
"redirections": [
{
"source_path": "hololens/old-article",
"redirect_url": "/base-url/new-article#section-about-old-topic",
"redirect_document_id": false
},
source_path
je relativní cesta úložiště ke starému článku, který odebíráte. Ujistěte se, že cesta začíná sadou docset (v tomto případěhololens
) a zahrnuje příponu.md
souboru.redirect_url
je relativní veřejná adresa URL ze starého článku do nového článku. Ujistěte se, že tato adresa URL neobsahuje.md
a začíná/
, protože odkazuje na veřejnou adresu URL, a ne cestu k úložišti. Propojení s oddílem v novém článku pomocí#section
je povolené. V případě potřeby můžete také použít absolutní cestu k jinému webu.redirect_document_id
označuje, jestli chcete zachovat ID dokumentu z předchozího souboru. Výchozí hodnota jefalse
. Pokud chcete zachovat hodnotu atributums.documentid
z přesměrovaného článku, použijtetrue
. Pokud zachováte ID dokumentu, data, jako jsou zobrazení stránek a hodnocení, budou přenesena do cílového článku. Tento postup proveďte, pokud je přesměrování primárně přejmenování, a ne ukazatel na jiný článek, který se zabývá pouze některými stejným obsahem.
Pokud přidáte přesměrování, nezapomeňte odstranit i starý soubor.
Pomocí následujícího pracovního postupu vytvořit nové články v úložišti dokumentace prostřednictvím GitHubu ve webovém prohlížeči:
Pomocí tlačítka For k v pravém horním rohu vytvořte fork z výchozí větve hlavnímicrosoftDocs/hololens.
Ve složce hololens vyberte Vytvořit nový soubor v pravém horním rohu.
Vytvořte název stránky pro článek (místo mezer použijte pomlčky a nepoužívejte interpunkci ani apostrofy) a připojte ".md".
Důležité
Ujistěte se, že nový článek vytvoříte ze složky hololens. Můžete to potvrdit tak, že v novém řádku názvu souboru vyhledáte /hololens/.
V horní části nové stránky přidejte následující blok metadat:
--- title: description: author: ms.author: ms.date: ms.topic: article keywords: ---
Vyplňte příslušná pole metadat, jak je popsáno výše v Úpravy existujícího článku.
Napsat obsah článku pomocí Základy Markdownu.
V dolní části článku přidejte oddíl
## See also
s odkazy na další relevantní články.Po dokončení vyberte Potvrdit nový soubor.
Vyberte Nová žádost o přijetí změn a sloučíte větev hlavního forku do MicrosoftDocs/hololens hlavní (ujistěte se, že šipka ukazuje na správný cíl).
Následující zdroje informací vám pomůžou naučit se upravovat dokumentaci pomocí jazyka Markdown:
- základy Markdownu
- [Další zdroje informací pro zápis Markdownu pro
Vzhledem k tomu, jak se tabulky stylují v Microsoft Learn, nebudou mít ohraničení ani vlastní styly, i když vyzkoušíte vložené šablony stylů CSS. Zdá se, že bude fungovat po krátkou dobu, ale nakonec platforma odstraní styling z tabulky. Takže plánujte dopředu a udržujte tabulky jednoduché. Tady je web, který usnadňuje tabulky Markdownu: [Generátor tabulek]](https://www.tablesgenerator.com/markdown_tables).
Rozšíření
Obrázky budete muset nahrát do složky hololens/images v úložišti a pak na ně odpovídajícím způsobem odkazovat v článku. Obrázky se automaticky zobrazí v plné velikosti, což znamená, že velké obrázky vyplní celou šířku článku. Před nahráním obrázků doporučujeme předem nastavit jejich velikost. Doporučená šířka je 600 až 700 pixelů, i když byste měli velikost zvětšit nebo snížit, pokud jde o hustý snímek obrazovky nebo zlomek snímku obrazovky.
Důležité
Obrázky můžete před sloučením nahrát jenom do rozvětvovaného úložiště. Pokud tedy plánujete přidávat obrázky do článku, budete muset pomocí nástroje Visual Studio Code přidat obrázky do složky "images" vašeho forku jako první nebo se ujistěte, že jste ve webovém prohlížeči provedli následující kroky:
- Rozvětvoval úložiště MicrosoftDocs/hololens.
- Upravili jste článek ve forku.
- Nahráli jste obrázky, na které odkazujete v článku, do složky hololens/images ve forku.
- Vytvořili jste žádost o přijetí změn pro sloučení forku do větve MicrosoftDocs/hololens main.
Pokud chcete zjistit, jak nastavit vlastní forkované úložiště, postupujte podle pokynů pro vytvoření nového článku.
Při úpravách na GitHubu pomocí webového prohlížeče můžete před potvrzením náhledu vybrat kartu Náhled v horní části stránky.
Poznámka
Náhled změn v Microsoft Learn je dostupný jenom zaměstnancům Microsoftu.
Zaměstnanci Microsoftu: Když se vaše příspěvky sloučí do výchozí větve, hlavní, můžete obsah zkontrolovat, než bude veřejně přístupný na </hololens?branch=main>. Najděte svůj článek pomocí obsahu v levém sloupci.
Úpravy v prohlížeči představují nejjednodušší způsob, jak provést rychlé změny, ale má několik nevýhod:
- Nemáte kontrolu pravopisu.
- Nezískáte žádné inteligentní propojení s jinými články (musíte ručně zadat název souboru článku).
- Může to být obtěžka pro nahrání a odkaz na obrázky.
Pokud se s těmito problémy nechcete zabývat, použijte desktopového klienta, jako je Visual Studio Code, s několika užitečnými rozšířeními, při přispívání.
Z důvodů uvedených výšemůžete místo webového prohlížeče raději použít desktopového klienta k úpravě dokumentace. Doporučujeme používateditoru Visual Studio Code
Pokud chcete nakonfigurovat Visual Studio Code tak, aby fungoval s tímto úložištěm, postupujte takto:
- Ve webovém prohlížeči:
- Nainstalujte Git pro počítač.
- Nainstalujte Visual Studio Code.
- Fork MicrosoftDocs/hololens, pokud jste to ještě neudělali.
- Ve forku vyberte Klonovat nebo stáhnout a zkopírujte adresu URL.
- Vytvořte místní klon forku v editoru Visual Studio Code:
- V nabídce
Zobrazit vybertepaletu příkazů. - Zadejte Git: Clone.
- Vložte zkopírovanou adresu URL.
- Zvolte, kam chcete klon uložit do počítače.
- V automaticky otevíraných oken vyberte
Otevřít úložiště.
- V nabídce
Pomocí následujícího pracovního postupu proveďte změny v dokumentaci pomocí editoru Visual Studio Code:
Poznámka
Všechny pokyny pro úpravy a vytváření článků a základy úprav Markdownu, které platí výše při použití editoru Visual Studio Code.
Ujistěte se, že je klonovaný fork aktuální s oficiálním úložištěm.
Ve webovém prohlížeči vytvořte žádost o přijetí změn pro synchronizaci nedávných změn od ostatních přispěvatelů ve výchozí větvi MicrosoftDocs/hololens, hlavní, do forku (ujistěte se, že šipka ukazuje na správný cíl).
V editoru Visual Studio Code vyberte tlačítko synchronizace, abyste synchronizovali nově aktualizovaný fork s místním klonem.
Vytvářejte nebo upravujte články v naklonovaném úložišti pomocí editoru Visual Studio Code.
Upravte jeden nebo více článků (v případě potřeby přidejte obrázky do složky obrázky).
Uložit změny vprůzkumníku. zvolte Uložit vše.
Potvrzení všech změn v správy zdrojového kódu(po zobrazení výzvy k zápisu) správy zdrojového kódu zvolte Potvrdit vše.
Výběrem tlačítka synchronizace synchronizujte změny zpět do zdroje (váš fork na GitHubu).
Ve webovém prohlížeči vytvořte žádost o přijetí změn pro synchronizaci nových změn ve forku zpět do MicrosoftDocs/hololens hlavní (ujistěte se, že šipka ukazuje na správný cíl).
Při úpravách dokumentace jsou užitečná následující rozšíření editoru Visual Studio Code:
rozšíření Docs Markdown pro Visual Studio Code – Pomocí Alt+M zobrazte nabídku možností vytváření obsahu v Microsoft Learn, například:
- Můžete hledat a odkazovat na obrázky, které jste nahráli.
- Přidejte formátování, jako jsou seznamy, tabulky a popisky, jako je
>[!NOTE]
. - Vyhledávání a odkazování na interní odkazy a záložky (odkazy na konkrétní oddíly na stránce)
- Chyby formátování jsou zvýrazněné (další informace získáte tak, že najedete myší na chybu).
kontrola pravopisu kódu – chybně napsaná slova budou podtržená; Klikněte pravým tlačítkem myši na chybně napsané slovo a změňte ho nebo ho uložte do slovníku.