Branches sind eine Funktion der Versionsverwaltung, die auf bestimmte Commits in Ihrem Repository verweisen. Ihr Bereitstellungs-Branch, in der Regel main genannt, repräsentiert den Inhalt, mit dem Ihre Live-Dokumentation erstellt wird. Alle anderen Branches sind unabhängig von Ihrer Live-Dokumentation, es sei denn, Sie entscheiden sich, sie in Ihren Bereitstellungs-Branch zu mergen. Branches ermöglichen es Ihnen, separate Instanzen Ihrer Dokumentation zu erstellen, um Änderungen vorzunehmen, Reviews einzuholen und neue Ansätze auszuprobieren, bevor Sie veröffentlichen. Ihr Team kann in Branches arbeiten, um gleichzeitig verschiedene Teile Ihrer Dokumentation zu aktualisieren, ohne zu beeinflussen, was Nutzer auf Ihrer Live-Website sehen, bis Sie Änderungen veröffentlichen. Wir empfehlen, beim Aktualisieren der Dokumentation stets mit Branches zu arbeiten, um Ihre Live-Website stabil zu halten und Review-Workflows zu ermöglichen.
  • Benennen Sie Branches eindeutig, damit Teammitglieder verstehen, woran Sie arbeiten.
  • Löschen Sie Branches nach dem Mergen, um Ihr Repository aufgeräumt zu halten.
  • Informieren Sie Ihr Team, wenn Sie an größeren Änderungen arbeiten, die sich auf ihre Arbeit auswirken könnten.

​
Einen Branch erstellen

  1. Wählen Sie in der Editor-Toolbar den Branchnamen aus (standardmäßig meist main).
  2. Wählen Sie New Branch.
  3. Geben Sie einen aussagekräftigen Namen für den Branch ein, z. B. update-getting-started oder fix-api-examples.
  4. Wählen Sie Create Branch.

​
Änderungen in einem Branch speichern

Um Ihre Änderungen in einem Branch zu speichern, klicken Sie oben rechts im Editor auf Save Changes. Dadurch wird ein Commit erstellt und Ihre Arbeit in Ihren Branch gepusht.

​
Branches wechseln

  1. Wählen Sie den Branchnamen in der Editor-Toolbar aus.
  2. Wählen Sie im Dropdown-Menü den Branch aus, zu dem Sie wechseln möchten.
Nicht gespeicherte Änderungen gehen beim Wechseln des Branches verloren. Speichern oder veröffentlichen Sie Ihre Arbeit, bevor Sie den Branch wechseln.