Dateien über die Pagure-Weboberfläche bearbeiten

Hanku Lee Version F33 and newer Last review: 2023-04-18
Viele der Repositorys wurden inzwischen zu Fedora Forge migriert. Beachten Sie die aktualisierte Anleitung.

Dieser Abschnitt beschreibt, wie Sie zu bestehender Dokumentation beitragen können – also zu Dokumentation, die bereits auf der Webseite veröffentlicht wurde. Bevor Sie mit dieser Vorgehensweise beginnen, stellen Sie sicher, dass Sie alle Voraussetzungen dafür erfüllen.

Wenn Sie Interesse daran haben, zu den Veröffentlichungshinweisen beizutragen, finden Sie weitere Informationen auf der entsprechenden Seite.

Jede Seite der Fedora-Dokumentation enthält oben einen Link „Edit this Page“. Einfache Aktualisierungen können direkt über die Weboberfläche von Pagure vorgenommen werden. Bei größeren oder komplexeren Änderungen sollten Sie diese vor dem Absenden offline vorbereiten und testen.

Online-Bearbeitung in Pagure

  1. Klicken Sie auf den Link „Edit this Page“, um den Quellcode der Dokumentation zu laden. Sie werden zum entsprechenden Inhaltsrepository in Pagure weitergeleitet.

  2. Klicken Sie rechts oberhalb der Quellcode-Liste auf „Fork and Edit“. (Wenn Sie das Repository bereits geforkt haben, ist dieser Knopf mit „Edit in your fork“ beschriftet und Sie können zum nächsten Schritt übergehen.)

    1. Falls Sie noch nicht bei Pagure angemeldet sind, werden Sie nach Ihren Zugangsdaten gefragt.

    2. Warten Sie, bis der Vorgang abgeschlossen ist. Möglicherweise müssen Sie die Seite aktualisieren, da sie sich nach Abschluss des Vorgangs nicht immer automatisch aktualisiert.

  3. Sobald die Datei in Ihrem Fork geladen ist, nehmen Sie alle notwendigen Änderungen am Inhalt vor, übertragen Sie diese in Ihren Fork und erstellen Sie einen Pull Request (PR).

    1. Jeder Pull Request sollte von einem eigenen Zweig in Ihrem Repository aus erstellt werden. Wählen Sie im Commit-Editor unter „Branch“ die Option „New branch“ und geben Sie dem Zweig einen kurzen, eindeutigen Namen.

    2. Füllen Sie das Formular für die Commit-Nachricht aus.

    3. Klicken Sie auf „Commit changes“, um den Zweig zu erstellen und diese Änderungen in Ihrem Fork zu speichern.

  4. Sobald der Commit gespeichert ist, wird die Seite aktualisiert und zeigt eine Liste der Commits für Ihren Fork an.

  5. Um weitere, damit zusammenhängende Änderungen einzufügen, wiederholen Sie diesen Vorgang und übertragen Sie die Änderungen in denselben Zweig.

  6. Wenn Sie fertig sind, klicken Sie auf „Create pull request“ und füllen Sie das PR-Formular aus, um Ihren Zweig an das Upstream-Repository zu übermitteln.

Tipps für Git-Commits

  • Verwenden Sie bei der Benennung Ihres Zweiges ausschließlich ASCII-Buchstaben, Ziffern, Bindestriche (-) und Unterstriche (_). Der Name darf einzelne Punkte (.) enthalten, aber nicht damit beginnen oder enden. Leerzeichen, Doppelpunkte (..) und die meisten anderen Interpunktionszeichen sind nicht zulässig.

  • Der Commit-Titel bestimmt, wie Ihre Änderung im Repository-Protokoll der Seite identifiziert wird. Der vorgeschlagene Titel „Update Pfadname“ ist für kleinere Änderungen ausreichend. Tipps zum Verfassen aussagekräftiger Commit-Nachrichten finden Sie in commit.style von Tim Pope (Autor von vim).

  • Nutzen Sie das Feld „Commit Description“, um bei Bedarf zusätzliche Details anzugeben, fassen Sie sich aber kurz. Sie haben die Möglichkeit, Ihre Änderungen zu erläutern oder zu diskutieren, wenn Sie Ihren Pull Request einreichen.

Offline-Bearbeitung

  1. Klicken Sie auf den Link „Edit this Page“, um den Quelltext der Dokumentation zu laden. Sie werden zum entsprechenden Inhaltsrepository in Pagure weitergeleitet. Sobald Sie das richtige Repository gefunden haben, erstellen Sie einen Fork, falls Sie es noch nicht geforkt haben:

    1. Klicken Sie in der oberen rechten Ecke auf „Fork“.

    2. Falls Sie noch nicht bei Pagure angemeldet sind, werden Sie nach Ihren Zugangsdaten gefragt.

    3. Warten Sie, bis der Vorgang abgeschlossen ist. Möglicherweise müssen Sie die Seite neu laden, da sie sich nach Abschluss des Vorgangs nicht immer automatisch aktualisiert.

    4. Klonen Sie Ihren Fork.

  2. Checken Sie den neuen Zweig aus und fügen Sie Ihre Beiträge hinzu.

  3. Wenn Sie neue Dateien hinzugefügt haben, stellen Sie sicher, dass diese an einer geeigneten Stelle in der Konfigurationsdatei nav.adoc des Repositorys eingebunden sind.

  4. Erstellen Sie das Projekt lokal und vergewissern Sie sich, dass alles Ihren Erwartungen entspricht. Anweisungen dazu finden Sie unter Lokale Vorschau erstellen.

  5. Sobald Sie fertig sind, übernehmen Sie Ihre Änderungen und laden sie in Ihren Fork hoch.

  6. Verwenden Sie Pagure, um einen Pull Request von Ihrem Fork zum Master-Zweig des Haupt-Repositorys zu erstellen.

Verwalten Ihres Pull Requests

Jemand wird Ihren Pull Request sehen und ihn entweder mergen oder Feedback geben, falls es Verbesserungsvorschläge gibt. Arbeiten Sie mit den Kommentatoren zusammen, um sicherzustellen, dass Ihre Beiträge den Standards entsprechen.

Wenn innerhalb weniger Tage niemand auf Ihren Pull Request reagiert, versuchen Sie, ihn über die wöchentlichen Meetings, den Matrix-Kanal (#docs im Fedora Chat) oder in den Foren zu kommunizieren.

Ihre Änderungen werden nach dem Mergen des Pull Requests online sichtbar sein. Die Website wird stündlich aktualisiert. Sollten Ihre Änderungen nicht innerhalb von 60 Stunden nach dem Mergen Ihres Pull Requests online erscheinen, kontaktieren Sie bitte asamalik (Adam Šamalík) im IRC-Kanal und fragen Sie ihn danach.

Want to help? Learn how to contribute to Fedora Docs ›