Skip to main content

Konfigurieren von Umleitungen

Wenn sich der Titel, die Version oder der Speicherort eines Artikels ändert, können Sie eine Umleitung zum aktuellen Inhalt erstellen.

Informationen zu Umleitungen

Wenn eine Änderung an einem Artikel vorgenommen wird, der sich auf die Fähigkeit der Benutzer auswirkt, ihn zu finden, erstellen wir eine Umleitung von allen veralteten Versionen zum aktuellen Inhalt. Dies ist möglicherweise erforderlich, wenn der Titel eines Artikels geändert wird, eine neue Version hinzugefügt wird oder der Speicherort der Datei geändert wird.

Umleitungen können lokal oder extern konfiguriert werden.

Konfigurieren von lokalen Umleitungen

Innerhalb von GitHub Docs können Sie von einer Datei zu einer anderen oder von einer Version zu einer anderen umleiten.

Dateiübergreifende Umleitungen

Wenn Sie den Namen eines Artikels ändern und möchten, dass die alte URL eine Umleitung zur neuen URL für alle Versionen bereitstellt, verwenden Sie die redirect_from-Titelei mit dem Pfad zum alten Namen des Artikels. Wenn du den Namen eines Artikels änderst und möchtest, dass verschiedene Versionen zu verschiedenen URLs umgeleitet werden sollen, führe die Schritte im Abschnitt Versionsübergreifende Umleitungen aus.

Im folgenden Beispiel wurde der Artikel "Alles über Commits" in "Erstellen des ersten Commits" umbenannt. Die redirect_from-Titelei leitet alle Personen um, die zur alten Artikel-URL zu der URL des neuen Artikels navigieren.

title: Creating your first commit
redirect_from:
  - /content/get-started/all-about-commits

Weitere Details finden Sie unter redirect_from in der GitHub Docs-README-Datei.

Automatische Umleitungen für URLs, die keine Version enthalten

Wenn eine URL für eine Seite ohne Version (https://docs.github.com/ARTICLE anstelle von https://docs.github.com/VERSION/ARTICLE) eingegeben wird, erstellt sie automatisch eine Umleitung an die erste verfügbare Version der Seite.

Die Reihenfolge der Rangfolge wird in lib/all-versions.js angegeben. Die aktuelle Reihenfolge der Rangfolge lautet:

  1. GitHub Free, GitHub Pro oder GitHub Team (fpt)
  2. GitHub Enterprise Cloud (ghec)
  3. GitHub Enterprise Server (ghes)

Wenn eine Seite mit dem Titel ARTICLE nur in GitHub Enterprise Cloud und GitHub Enterprise Server verfügbar ist, wird der Link https://docs.github.com/ARTICLE automatisch an https://docs.github.com/enterprise-cloud@latest/ARTICLE umgeleitet, da GitHub Enterprise Cloud Vorrang vor GitHub Enterprise Server hat.

Wenn ARTICLE in "Free", "Pro" oder "Team" verfügbar ist, tritt keine Umleitung auf, da fpt-Seiten nicht über ein Versionssegment verfügen, sodass der fpt-bei Inhalt https://docs.github.com/ARTICLE gerendert wird.

Versionübergreifende Umleitungen

Wenn die URL für eine Version eines Artikels zu einer URL für eine andere Version oder komplett an eine andere URL umgeleitet werden soll, müssen Sie die Datei redirect-exceptions.txt im Verzeichnis src/redirects aktualisieren.

Wenn Sie beispielsweise die Version "Free", "Pro" oder "Team" (fpt) eines Artikels entfernen, wird die URL automatisch zur nächsten verfügbaren Version der Seite umgeleitet. Wenn sie zu einer Version umleiten soll, die in der Reihenfolge der Rangfolge niedriger ist, oder vollständig auf eine andere Seite, müssen Sie eine Ausnahme angeben.

Jeder Eintrag in der redirect-exceptions-Datei sollte mit dem Pfad beginnen, zu dem Sie umleiten_möchten, einschließlich der Version, gefolgt von einer nicht sortierten Liste der Pfade, von_denen Sie umleiten möchten. Im folgenden Beispiel werden die Pfade in der nicht sortiertem Liste an die GitHub Enterprise Cloud-Version von Exportieren von Mitgliedsinformationen für deine Organisation umgeleitet.

/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /enterprise-server@3.3/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /enterprise-server@3.4/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /enterprise-server@3.5/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization

Konfigurieren von externen Umleitungen

Selten werden Inhalte außerhalb der GitHub Docs-Website verschoben. Aktualisieren Sie die external-sites.json-Datei für diese Arten von Umleitungen im src/redirects-Verzeichnis.

Jeder Eintrag in der external-sites.json-Datei ist ein Schlüsselwertpaar, bei dem der Schlüssel der Pfad zum Speicherort des Inhalts ist und der Wert der Pfad, an den er umgeleitet werden soll.

  "/github-status": "https://www.githubstatus.com/",
  "/articles/github-security": "https://github.com/security",