Ändern eines Artikeltitels
Manchmal ist es notwendig, den Titel eines Hilfeartikels zu ändern. Beim Ändern eines Artikeltitels sollten mehrere Überlegungen berücksichtigt werden.
Hintergrund zum Ändern des Dateinamens
Es gibt verschiedene Gründe, weshalb der Titel des Artikels direkt dem Namen der Markdowndatei entspricht, die diesen Artikel enthält:
- Suchmaschinenoptimierung (Search Engine Optimization, SEO): Beim Verwenden echter Wörter, die dem Inhalt eines Artikels in einer URL entsprechen, werden diese Artikel für Suchmaschinen stärker gewichtet. Weitere Informationen findest du unter „Verbessern der Strukturen deiner URLs“ im Leitfaden für die Google-Suchmaschinenoptimierung.
Orte, die bei einer Titeländerung aktualisiert werden sollten
Es gibt mehrere Orte, die möglicherweise aktualisiert werden sollten, wenn ein Artikel einen neuen Titel erhält.
Frontmatter und Metadatenabschnitt
Jeder Artikel enthält einen Metadatenabschnitt oder eine Frontmatter am Anfang des Artikels, der mithilfe der YAML-Syntax formatiert ist. Dieser Metadatenabschnitt generiert den Titel des Artikels und enthält weitere wichtige Daten, z. B. URL-Weiterleitungen und manchmal sogar kurze Beschreibungs-Conrefs, die mit einem wiederverwendbaren Einführungstext verknüpft sind.
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
Checkliste für Frontmatterupdates
- Aktualisieren des Titels mit normaler Groß-/Kleinschreibung
- Aktualisiere Weiterleitungen. Bei fast jeder Titeländerung sollte eine Weiterleitung hinzugefügt werden, die auf die alte URL des Artikels verweist. Außerdem sollte sichergestellt werden, dass alle Weiterleitungen in der Frontmatter des alten Artikel erhalten bleibt.
Dateiname
Du kannst den git mv-Befehl in deinem Terminal verwenden, um den Dateinamen zu ändern.
$ git mv old-article-name.md new-article-name.md
Übergeordnete Indexdatei
Aktualisiere den Link zur Datei in der übergeordneten index.md-Datei, die das Inhaltsverzeichnis generiert.
Inlinelinks in anderen Artikeln
Artikel sind innerhalb unserer Dokumentation miteinander verknüpft. Du solltest nach dem Dateinamen und dem Titel suchen, um Links zu finden, die aktualisiert werden sollen.
Verknüpfungen innerhalb von GitHub
Suche im Produkt nach Links zu alten Titeln. Wenn du veraltete Links findest, wende dich an das zuständige Team oder die entsprechenden Techniker, um sie darüber zu informieren, dass sich der Link geändert hat, und bitte sie, den Link zu aktualisieren. Wenn du nicht sicher bist, an wen du dich wenden solltest, kannst du ein Mitglied des GitHub Docs-Teams fragen. Du kannst ihnen auch entgegenkommen und einen Pull Request mit den aktualisierten Links erstellen und das entsprechende Team bitten, einen Merge durchzuführen, sobald der aktualisierte Titel enthalten ist.