Beitragen zur HoloLens-Dokumentation
Willkommen bei der HoloLens-Dokumentation! Alle Artikel, die Sie in diesem Repository erstellen oder bearbeitensind für die Öffentlichkeit sichtbar.
Die HoloLens-Dokumentation wird in Microsoft Learn veröffentlicht, die GitHub-aromatisierte Markdown mit Markdig-Features verwendet. Der Inhalt, den Sie in diesem Repository bearbeiten, wird in stilisierte Seiten formatiert, die bei /hololens
angezeigt werden.
Auf dieser Seite werden die grundlegenden Schritte und Richtlinien für beiträge und Links zu Den Markdown-Grundlagen behandelt. Vielen Dank für Ihren Beitrag!
Repositoryname | URL |
---|---|
HoloLens | MicrosoftDocs/HoloLens- |
Mixed Reality | MicrosoftDocs/Mixed-Reality- |
Leitfaden für VR-Enthusiasten | MicrosoftDocs/Mixed-Reality/enthusiast-guide |
Wenn Sie noch kein Konto besitzen, müssen Sie ein GitHub-Kontoerstellen.
Hinweis
Wenn Sie ein Microsoft-Mitarbeiter sind, verknüpfen Sie Ihr GitHub-Konto mit Ihrem Microsoft-Alias im Microsoft Open Source-Portal. Treten Sie den "Microsoft"- und "MicrosoftDocs"- Organisationen bei.
Beim Einrichten Ihres GitHub-Kontos empfehlen wir auch die folgenden Sicherheitsvorkehrungen:
- Erstellen Sie ein sicheres Kennwort für Ihr GitHub-Konto.
- Aktivieren Sie zweistufige Authentifizierung.
- Speichern Sie Ihre Wiederherstellungscodes an einem sicheren Ort.
- Aktualisieren Sie Ihre einstellungen für öffentliche Profile.
- Legen Sie Ihren Namen fest, und erwägen Sie, Ihre öffentlichen E-Mail- auf Meine E-Mail-Adresse nicht anzeigen.
- Es wird empfohlen, ein Profilbild hochzuladen, da eine Miniaturansicht in Microsoft Learn-Artikeln angezeigt wird, zu der Sie beitragen.
- Wenn Sie die Befehlszeile verwenden möchten, sollten Sie Git Credential Manager für Windowseinrichten. Auf diese Weise müssen Sie Ihr Kennwort nicht jedes Mal eingeben, wenn Sie einen Beitrag leisten.
Das Veröffentlichungssystem ist an GitHub gebunden, daher sind diese Schritte wichtig. Sie werden entweder als Autor oder Mitwirkender für jeden Artikel mit Ihrem GitHub-Alias aufgeführt.
Verwenden Sie den folgenden Workflow, um Aktualisierungen vorzunehmen, um einen vorhandenen Artikel über GitHub in einem Webbrowser zu
Navigieren Sie zu dem Artikel, den Sie im Ordner "hololens" bearbeiten möchten.
Wählen Sie oben rechts die Schaltfläche "Bearbeiten" (Bleistiftsymbol) aus.
Dadurch wird automatisch eine Einwegverzweigung von der Standardverzweigung Haupt-verzweigt.
Bearbeiten Sie den Inhalt des Artikels gemäß den Markdown-Grundlagen.
Aktualisieren von Metadaten am Anfang jedes Artikels:
- Titel: Seitentitel, der auf der Registerkarte "Browser" angezeigt wird, wenn der Artikel angezeigt wird. Seitentitel werden für SEO und Indizierung verwendet, sodass Sie den Titel nur ändern, wenn dies erforderlich ist (obwohl dies weniger wichtig ist, bevor die Dokumentation öffentlich wird).
- Beschreibung: Schreiben Sie eine kurze Beschreibung des Artikels Inhalte, die SEO und Discovery fördern.
- Autor: Wenn Sie der primäre Besitzer der Seite sind, fügen Sie hier Ihren GitHub-Alias hinzu.
- ms.author: Wenn Sie der primäre Besitzer der Seite sind, fügen Sie hier Ihren Microsoft-Alias hinzu (Sie benötigen nicht @microsoft.com, nur den Alias).
- ms.date: Aktualisieren Sie das Datum, wenn Sie der Seite hauptinhalte hinzufügen, jedoch nicht für Korrekturen wie Klarstellung, Formatierung, Grammatik oder Rechtschreibung.
- Schlüsselwörter: Schlüsselwörter helfen bei SEO (Suchmaschinenoptimierung). Fügen Sie Schlüsselwörter, getrennt durch ein Komma und ein Leerzeichen, die für Ihren Artikel spezifisch sind, aber keine Interpunktion nach dem letzten Schlüsselwort in Ihrer Liste hinzu. Sie müssen keine globalen Schlüsselwörter hinzufügen, die für alle Artikel gelten, da diese an anderer Stelle verwaltet werden.
Wenn Sie Ihre Artikelbearbeitungen abgeschlossen haben, scrollen Sie nach unten, und wählen Sie Dateiänderung vorschlagenaus.
Wählen Sie auf der nächsten Seite Pullanforderung erstellen aus, um die automatisch erstellte Verzweigung in der Standardverzweigung zusammenzuführen, Haupt-.
Wiederholen Sie die vorstehenden Schritte für den nächsten Artikel, den Sie bearbeiten möchten.
Wenn Ihre Änderung einen vorhandenen Artikel umbenennen oder löschen soll, müssen Sie eine Umleitung hinzufügen. Auf diese Weise bleibt jeder, der einen Link zum vorhandenen Artikel hat, immer noch an der richtigen Stelle. Umleitungen werden von der .openpublishing.redirection.json Datei im Stammverzeichnis des Repositorys verwaltet.
Um eine Umleitung zu .openpublishing.redirection.jsonhinzuzufügen, fügen Sie einen Eintrag zum redirections
Array hinzu:
{
"redirections": [
{
"source_path": "hololens/old-article",
"redirect_url": "/base-url/new-article#section-about-old-topic",
"redirect_document_id": false
},
Die
source_path
ist der relative Repositorypfad zum alten Artikel, den Sie entfernen. Stellen Sie sicher, dass der Pfad mit dem Docset (in diesem Fallhololens
) beginnt und die.md
Dateierweiterung enthält.Die
redirect_url
ist die relative öffentliche URL aus dem alten Artikel zum neuen Artikel. Stellen Sie sicher, dass diese URL nicht.md
enthält und mit/
beginnt, da sie sich auf die öffentliche URL und nicht auf den Repositorypfad bezieht. Das Verknüpfen mit einem Abschnitt innerhalb des neuen Artikels mithilfe von#section
ist zulässig. Sie können hier auch einen absoluten Pfad zu einer anderen Website verwenden, falls erforderlich.redirect_document_id
gibt an, ob Sie die Dokument-ID aus der vorherigen Datei beibehalten möchten. Der Standardwert istfalse
. Verwenden Sietrue
, wenn Sie denms.documentid
Attributwert aus dem umgeleiteten Artikel beibehalten möchten. Wenn Sie die Dokument-ID beibehalten, werden Daten wie Seitenansichten und Rangfolgen in den Zielartikel übertragen. Führen Sie dies aus, wenn die Umleitung in erster Linie eine Umbenennung ist und kein Zeiger auf einen anderen Artikel, der nur einige der gleichen Inhalte behandelt.
Wenn Sie eine Umleitung hinzufügen, müssen Sie auch die alte Datei löschen.
Verwenden Sie den folgenden Workflow, um neue Artikel im Dokumentations-Repository über GitHub in einem Webbrowser
Erstellen Sie eine Verzweigung aus der Standardverzweigung Haupt-von MicrosoftDocs/Hololens, indem Sie die Schaltfläche Verzweigung oben rechts verwenden.
Wählen Sie im Ordner "hololens" Neue Datei erstellen oben rechts aus.
Erstellen Sie einen Seitennamen für den Artikel (verwenden Sie Bindestriche anstelle von Leerzeichen, und verwenden Sie keine Interpunktion oder Apostrophe), und fügen Sie ".md" an.
Wichtig
Stellen Sie sicher, dass Sie den neuen Artikel aus dem Ordner "hololens" erstellen. Sie können dies bestätigen, indem Sie in der neuen Dateinamenzeile nach "/hololens/" suchen.
Fügen Sie oben auf der neuen Seite den folgenden Metadatenblock hinzu:
--- title: description: author: ms.author: ms.date: ms.topic: article keywords: ---
Füllen Sie die relevanten Metadatenfelder aus, wie weiter oben in Bearbeiten eines vorhandenen Artikelsbeschrieben.
Schreiben von Artikelinhalten mithilfe von Markdown Basics.
Fügen Sie unten im Artikel einen
## See also
Abschnitt mit Links zu anderen relevanten Artikeln hinzu.Wenn Sie fertig sind, wählen Sie neue Dateicommiten.
Wählen Sie Neue Pullanforderung aus, und führen Sie die Haupt- Verzweigung ihrer Fork in MicrosoftDocs/hololens Haupt- zusammen (stellen Sie sicher, dass der Pfeil auf das richtige Ziel zeigt).
Die folgenden Ressourcen helfen Ihnen, zu erfahren, wie Sie die Dokumentation mithilfe der Sprache Markdown bearbeiten:
- Markdown-Grundlagen
- [Zusätzliche Ressourcen zum Schreiben von Markdown-für
Da Tabellen in Microsoft Learn formatiert werden, verfügen sie nicht über Rahmen oder benutzerdefinierte Formatvorlagen, auch wenn Sie inline-CSS ausprobieren. Es scheint für einen kurzen Zeitraum zu funktionieren, aber schließlich wird die Plattform das Format aus der Tabelle entfernen. Planen Sie also voraus, und halten Sie Ihre Tabellen einfach. Hier ist eine Website, die Markdown-Tabellen einfach macht: [Tabellen-Generator]](https://www.tablesgenerator.com/markdown_tables).
Die Docs Markdown Extension für Visual Studio Code erleichtert auch die Tabellengenerierung, wenn Sie Visual Studio Code (siehe unten) zum Bearbeiten der Dokumentation verwenden.
Sie müssen Ihre Bilder in den Ordner "hololens/images" im Repository hochladen und dann im Artikel entsprechend darauf verweisen. Bilder werden automatisch in voller Größe angezeigt, was bedeutet, dass große Bilder die gesamte Breite des Artikels füllen. Es wird empfohlen, ihre Bilder vorab zu skalieren, bevor Sie sie hochladen. Die empfohlene Breite liegt zwischen 600 und 700 Pixel, Sie sollten jedoch eine Größe nach oben oder unten festlegen, wenn es sich um einen dichten Screenshot oder einen Bruchteil eines Screenshots handelt.
Wichtig
Sie können Bilder nur vor dem Zusammenführen in Ihr Verzweigungs-Repository hochladen. Wenn Sie also beabsichtigen, Bilder zu einem Artikel hinzuzufügen, müssen Sie visual Studio Code verwenden, um die Bilder zuerst dem Ordner "Bilder" Ihrer Verzweigung hinzuzufügen, oder stellen Sie sicher, dass Sie folgendes in einem Webbrowser abgeschlossen haben:
- Verzweigten Sie das MicrosoftDocs/hololens-Repository.
- Bearbeitete den Artikel in Ihrer Verzweigung.
- Laden Sie die Bilder hoch, auf die Sie in Ihrem Artikel verweisen, in den Ordner "hololens/images" in Ihrer Verzweigung.
- Es wurde eine Pullanforderung erstellt, um Ihre Verzweigung in den MicrosoftDocs/hololens Hauptzweig zusammenzuführen.
Folgen Sie den Anweisungen zum Erstellen eines neuen Artikels , um zu erfahren, wie Sie ein eigenes Verzweigungs-Repository einrichten.
Während Der Bearbeitung in GitHub über einen Webbrowser können Sie die Registerkarte Vorschau am oberen Rand der Seite auswählen, um eine Vorschau Ihrer Arbeit anzuzeigen, bevor Sie commiten.
Hinweis
Die Vorschau Ihrer Änderungen in Microsoft Learn ist nur für Microsoft-Mitarbeiter verfügbar.
Microsoft-Mitarbeiter: Wenn Ihre Beiträge in die Standardverzweigung zusammengeführt wurden, Haupt-, können Sie den Inhalt überprüfen, bevor er unter </hololens?branch=main>öffentlich wird. Suchen Sie Ihren Artikel mithilfe des Inhaltsverzeichnisses in der linken Spalte.
Das Bearbeiten im Browser ist die einfachste Möglichkeit, schnelle Änderungen vorzunehmen, es gibt jedoch ein paar Nachteile:
- Sie erhalten keine Rechtschreibprüfung.
- Sie erhalten keine intelligente Verknüpfung zu anderen Artikeln (Sie müssen den Dateinamen des Artikels manuell eingeben).
- Es kann ein Problem beim Hochladen und Verweisen auf Bilder sein.
Wenn Sie diese Probleme lieber nicht behandeln möchten, verwenden Sie einen Desktopclient wie Visual Studio Code mit einigen hilfreichen Erweiterungen, wenn Sie mitwirken.
Aus den gründen, die obenaufgeführt sind, können Sie lieber einen Desktopclient verwenden, um die Dokumentation anstelle eines Webbrowsers zu bearbeiten. Es wird empfohlen, Visual Studio Codezu verwenden.
Führen Sie die folgenden Schritte aus, um Visual Studio Code für die Arbeit mit diesem Repository zu konfigurieren:
- In einem Webbrowser:
- Installieren Sie Git für Ihren PC.
- Installieren Sie Visual Studio Code.
- Fork MicrosoftDocs/hololens, falls noch nicht geschehen.
- Wählen Sie in Ihrer Verzweigung Klonen aus, oder laden Sie herunter, und kopieren Sie die URL.
- Erstellen Sie einen lokalen Klon Ihrer Verzweigung in Visual Studio Code:
- Wählen Sie im Menü AnsichtBefehlspaletteaus.
- Geben Sie "Git: Clone" ein.
- Fügen Sie die kopierte URL ein.
- Wählen Sie aus, wo der Klon auf Ihrem PC gespeichert werden soll.
- Wählen Sie im Popup Repository öffnen aus.
Verwenden Sie den folgenden Workflow, um Änderungen an der Dokumentation mit Visual Studio Code vorzunehmen:
Hinweis
Alle Anleitungen zum Bearbeiten von und Erstellen von Artikeln sowie die Grundlagen zum Bearbeiten von Markdown-gelten auch bei verwendung von Visual Studio Code.
Stellen Sie sicher, dass Ihre geklonte Verzweigung mit dem offiziellen Repository auf dem neuesten Stand ist.
Erstellen Sie in einem Webbrowser eine Pullanforderung, um die letzten Änderungen von anderen Mitwirkenden in der Standardverzweigung von MicrosoftDocs/hololens, Haupt-, mit Ihrer Verzweigung zu synchronisieren (stellen Sie sicher, dass der Pfeil auf das richtige Ziel zeigt).
Wählen Sie in Visual Studio Code die Synchronisierungsschaltfläche aus, um ihre frisch aktualisierte Verzweigung mit dem lokalen Klon zu synchronisieren.
Erstellen oder bearbeiten Sie Artikel in Ihrem geklonten Repository mit Visual Studio Code.
Bearbeiten Sie einen oder mehrere Artikel (fügen Sie bei Bedarf Bilder zum Ordner "Bilder" hinzu).
Speichern Änderungen im Explorer-.
"Alles speichern" auswählen
Commit aller Änderungen in Quellcodeverwaltungs- ausführen (schreiben Sie commit-Nachricht, wenn Sie dazu aufgefordert werden).
Wählen Sie die Schaltfläche synchronisieren aus, um Ihre Änderungen wieder mit dem Ursprung zu synchronisieren (Ihre Verzweigung auf GitHub).
Erstellen Sie in einem Webbrowser eine Pullanforderung zum Synchronisieren neuer Änderungen in Ihrer Verzweigung zurück zu MicrosoftDocs/hololens Haupt- (stellen Sie sicher, dass der Pfeil auf das richtige Ziel zeigt).
Die folgenden Visual Studio Code-Erweiterungen sind beim Bearbeiten der Dokumentation hilfreich:
Docs Markdown Extension für Visual Studio Code – Verwenden Sie ALT+M-, um ein Menü der Microsoft Learn-Erstellungsoptionen anzuzeigen, z. B.:
- Suchen und verweisen Sie auf Bilder, die Sie hochgeladen haben.
- Fügen Sie Formatierungen wie Listen, Tabellen und Beschriftungen wie
>[!NOTE]
hinzu. - Suchen und verweisen Sie auf interne Links und Lesezeichen (Links zu bestimmten Abschnitten innerhalb einer Seite).
- Formatierungsfehler werden hervorgehoben (zeigen Sie mit der Maus auf den Fehler, um mehr zu erfahren).
Rechtschreibprüfung - falsch geschriebene Wörter werden unterstrichen; Klicken Sie mit der rechten Maustaste auf ein falsch geschriebenes Wort, um es zu ändern oder im Wörterbuch zu speichern.