Arbeiten an GitHub-Dokumentationen in einem Codespace

Sie können GitHub Codespaces verwenden, um an der Dokumentation für GitHub Docs zu arbeiten.

In diesem Artikel

Informationen zum GitHub Codespaces

GitHub Codespaces ermöglicht es Ihnen, in einer Entwicklungsumgebung zu arbeiten, die remote von Ihrem Computer gehostet wird. Ein schneller Einstieg ohne das Einrichten einer Arbeitsumgebung oder das Herunterladen von Dateien auf deinen lokaler Computer ist möglich.

Weitere Informationen finden Sie unter Schnellstart für GitHub Codespaces.

Arbeiten an der Dokumentation in einem Codespace

Bei den folgenden Schritten wird davon ausgegangen, dass Sie GitHub Codespaces eingerichtet haben, um Dateien mit Visual Studio Code für Web zu bearbeiten. Die Schritte sind sehr ähnlich, wenn Sie einen anderen Editor festgelegt haben. Weitere Informationen finden Sie unter Festlegen des Standard-Editors für GitHub Codespaces.

  1. Navigieren Sie zum Open-Source-Repository für GitHub Docs, github/docs.

  2. Wenn du eine Open-Source-Mitwirkender bist, forke das Repository, und führe dann die restlichen Schritte von deinen Fork aus. Weitere Informationen finden Sie unter Ein Repository forken.

  3. Erstelle einen Branch, um darin zu arbeiten. Weitere Informationen finden Sie unter Erstellen und Löschen von Branches in deinem Repository.

  4. Klicken Sie auf der Hauptseite des Repositorys auf "Code", und klicken Sie dann auf "Codespace auf BRANCH-NAME erstellen".

    Die Seite „Einrichten deines Codespace“ wird angezeigt. Nach kurzer Zeit wird die browserbasierte Version von Visual Studio Code angezeigt.

  5. Navigiere im Explorer zu der Markdowndatei, die du bearbeiten möchtest. Wenn es sich bei der Datei um einen Artikel handelt, befindet sie sich im content-Verzeichnis. Wenn es sich dabei um wiederverwendbare Inhalte handelt, befinden sich diese im data-Verzeichnis.

    In den meisten Fällen stimmt der Pfad zu einem Artikel im content-Verzeichnis mit dem Pfad in der URL (ohne die .md-Dateierweiterung) überein. Die Quelle des Artikels https://docs.github.com/en/codespaces/quickstart ist beispielsweise die Markdowndatei content/codespaces/quickstart.md.

  6. Bearbeite die Markdowndatei nach Bedarf.

  7. Speichere deine Änderungen.

  8. Committe und pushe deine Änderungen, entweder mithilfe der Ansicht Quellcodeverwaltung oder mithilfe von Git-Befehlen aus dem Terminal. Weitere Informationen finden Sie unter Informationen zu Git.

Erstellen eines Pull Requests

  1. Wechsle zum Tab „Pull Requests“ des github/docs-Repositorys unter github.com/github/docs/pulls.

  2. Klicke auf Neuer Pull Request.

  3. Wenn du eine Open-Source-Mitwirkender bist, klicke auf Forkübergreifend vergleichen, und wähle dann das von dir erstellte geforkte Repository sowie deinen Arbeitsbranch aus.

    Ändere andernfalls den „Vergleichs“-Branch in einen Arbeitsbranch.

  4. Überprüfe, ob die angezeigten Änderungen alle Änderungen enthalten, die du im Codespace vorgenommen hast. Wenn dies nicht der Fall ist, kann dies darauf hinweisen, dass es Änderungen gibt, die Sie nicht vom Codespace zu GitHub gepusht haben.

  5. Klicke auf Pull Request erstellen.

  6. Gib die Details für deinen Pull Request ein, und klicke auf Pull Request erstellen.

    Ihre Pull-Anforderung wird von einem Mitglied des GitHub Docs Teams überprüft.