Anleitung zum Erstellen, Bearbeiten, Verschieben oder Löschen von Seiten

Alle Seiten auf MDN Web Docs werden im Markdown-Format verfasst. Der Inhalt wird in einer Datei namens index.md geschrieben, die in einem eigenen, eindeutigen Verzeichnis gespeichert wird. Der Verzeichnisname repräsentiert den Namen der Seite. Zum Beispiel, wenn align-content eine neue CSS-Eigenschaft ist, für die Sie eine neue Referenzseite erstellen möchten, würden Sie im Verzeichnis en-us/web/css einen Ordner namens align-content erstellen und darin eine Datei namens index.md anlegen.

Es gibt viele verschiedene Seitentypen mit bestimmten Strukturen und unterstützenden Seitentemplates, die Sie als Startpunkt kopieren können.

Eine index.md-Datei eines Dokuments muss mit einem Kopfteil beginnen, das title, slug und page-type definiert. Alle diese Informationen im Kopfteil können in den oben genannten Seitentemplates gefunden werden. Alternativ finden Sie es möglicherweise hilfreich, das Kopfteil einer ähnlichen Dokumentation in deren index.md zu konsultieren.

Der allgemeine Schritt-für-Schritt-Prozess zum Erstellen einer Seite wäre:

1. Starten Sie einen neuen, aktuellen Branch, um darin zu arbeiten.

   bash

   cd ~/repos/mdn/content
   git checkout main
   git pull mdn main
   # Run "yarn" again to ensure you've
   # installed the latest Yari dependency.
   yarn
   git checkout -b my-add
   

2. Erstellen Sie ein oder mehrere neue Dokumentverzeichnisse, jedes mit eigenen index.md-Dateien.

3. Fügen Sie Ihre neuen Dateien hinzu, committen Sie sie und pushen Sie Ihren neuen Branch in Ihren Fork.

   bash

   git add files/en-us/folder/you/created
   git commit -m "appropriate message about your changes"
   git push -u origin my-add
   

4. Erstellen Sie Ihre Pull-Anfrage.

Das Verschieben von einem oder mehreren Dokumenten oder eines gesamten Dokumentbaumes ist einfach, da wir einen speziellen Befehl erstellt haben, der die Details für Sie erledigt:

yarn content move <from-slug> <to-slug> [locale]

Sie müssen lediglich den Slug des bestehenden Dokuments, das Sie verschieben möchten, angeben (z.B. Web/HTTP/Authentication) sowie den Slug seines neuen Standorts (z.B. Web/HTTP/Auth), gefolgt von der Lokalisierung des bestehenden Dokuments, falls erforderlich (standardmäßig en-US).

Wenn das bestehende Dokument, das Sie verschieben möchten, untergeordnete Dokumente hat (d.h., es repräsentiert einen Dokumentbaum), wird der Befehl yarn content move den gesamten Baum verschieben.

Zum Beispiel, wenn Sie den gesamten Baum /en-US/Web/HTTP/Authentication nach /en-US/Web/HTTP/Auth verschieben möchten, würden Sie folgende Schritte ausführen:

1. Sie starten einen neuen Branch, um darin zu arbeiten.

   bash

   cd ~/repos/mdn/content
   git checkout main
   git pull mdn main
   # Run "yarn" again just to ensure you've
   # installed the latest Yari dependency.
   yarn
   git checkout -b my-move
   

2. Führen Sie das Verschieben aus (dies wird vorhandene Dateien löschen und modifizieren sowie neue Dateien erstellen).

   bash

   yarn content move Web/HTTP/Authentication Web/HTTP/Auth
   

3. Sobald Dateien verschoben sind, müssen wir Verweise auf diese Dateien in den anderen Inhaltsdateien ebenfalls aktualisieren. Verwenden Sie den folgenden Befehl, um alle Verweise automatisch in einem Schritt zu aktualisieren:

   bash

   node scripts/update-moved-file-links.js
   

4. Fügen Sie alle gelöschten, erstellten und modifizierten Dateien hinzu und committen Sie diese, sowie pushen Sie Ihren Branch in Ihren Fork.

   bash

   git add .
   git commit -m "Move Web/HTTP/Authentication to Web/HTTP/Auth"
   git push -u origin my-move
   

5. Erstellen Sie Ihre Pull-Anfrage.

Dokumente sollten nur unter besonderen Umständen von den MDN Web Docs entfernt werden. Wenn Sie über das Löschen von Seiten nachdenken, besprechen Sie dies bitte zuerst mit dem MDN Web Docs-Team in den Chat-Räumen von MDN Web Docs.

Das Löschen von einem oder mehreren Dokumenten oder eines gesamten Dokumentbaumes ist einfach, ähnlich wie das Verschieben von Seiten, da wir einen speziellen Befehl erstellt haben, der die Details für Sie erledigt:

yarn content delete <document-slug> [locale]

Sie müssen lediglich den Slug des bestehenden Dokuments, das Sie löschen möchten, angeben (z.B. Web/HTTP/Authentication), gefolgt von der Lokalisierung des bestehenden Dokuments, falls erforderlich (standardmäßig en-US).

Wenn das bestehende Dokument, das Sie löschen möchten, untergeordnete Dokumente hat (d.h., es repräsentiert einen Dokumentbaum), müssen Sie auch die Option -r, --recursive angeben, andernfalls schlägt der Befehl fehl.

Zum Beispiel, wenn Sie den gesamten Baum /en-US/Web/HTTP/Authentication löschen möchten, würden Sie folgende Schritte ausführen:

1. Sie starten einen neuen Branch, um darin zu arbeiten.

   bash

   cd ~/repos/mdn/content
   git checkout main
   git pull mdn main
   # Run "yarn" again just to ensure you've
   # installed the latest Yari dependency.
   yarn
   git checkout -b my-delete
   

2. Führen Sie das Löschen aus.

   bash

   yarn content delete Web/HTTP/Authentication --recursive
   

3. Fügen Sie eine Umleitung hinzu. Die Zielseite kann eine externe URL oder eine andere Seite auf den MDN Web Docs sein.

   bash

   yarn content add-redirect /en-US/path/of/deleted/page /en-US/path/of/target/page
   

4. Fügen Sie alle gelöschten Dateien hinzu und committen Sie diese, sowie pushen Sie Ihren Branch in Ihren Fork.

   bash

   git commit -a
   git push -u origin my-delete
   

5. Erstellen Sie Ihre Pull-Anfrage.

yarn content delete "Mozilla/Add-ons/WebExtensions/Debugging_(before_Firefox_50)"

Das Entfernen von Inhalten aus den MDN Web Docs führt unweigerlich auch zu einer Aktualisierung der bestehenden Inhalte. Da viele Artikel auf andere verlinken, werden die entfernten Inhalte wahrscheinlich an anderer Stelle referenziert. Das Hinzufügen der Umleitung wird die Auswirkungen der Entfernung von Inhalten mildern; dennoch ist es am besten, den Inhalt zu bearbeiten, um die Änderung zu spiegeln, und die Inhaltsbearbeitungen zusammen mit der Pull-Anfrage zur Entfernung einzuschließen.

Um eine Seite zu bearbeiten, müssen Sie die Seitenquelle in unserem content Repository finden. Der einfachste Weg, um sie zu finden, ist zur Seite zu navigieren, die Sie bearbeiten möchten, zum Seitenende zu gehen und auf den Link "View the source on GitHub" zu klicken.

Wenn Sie die Seite lokal bearbeiten, können Sie, um zu sehen, wie Ihre Änderungen aussehen, in das Inhalts-Repo-Verzeichnis gehen, den CLI-Befehl yarn start ausführen, im Browser zu localhost:5042 gehen und zur Seite navigieren, um sie anzusehen. Geben Sie den Titel in das Suchfeld ein, um sie leicht zu finden. Die Vorschauseite wird im Browser aktualisiert, während Sie die Quelle bearbeiten.

Um eine Datei an Ihren Artikel anzuhängen, müssen Sie sie nur im gleichen Verzeichnis wie die index.md-Datei des Artikels einfügen. Fügen Sie die Datei in Ihrer Seite ein, typischerweise über ein <a> Element.