Dateien über die Pagure-Weboberfläche bearbeiten

Hanku Lee Version F33 and newer Last review: 2023-04-18

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.

  • The commit title is how your edit will be identified in the repository log for the page. The suggested title, "Update pathname", is sufficient for small edits. For some advice on writing good commit messages, see commit.style by Tim Pope (author of vim).

  • Use the "Commit Description" field to provide additional detail if necessary, but keep it short. You will have the opportunity to explain or discuss your changes when you submit your PR.

Offline-Bearbeitung

  1. Click the "Edit this Page" link to load the documentation source. You will be taken to the appropriate content repository in Pagure. Once you have located the correct repository, make a fork if you do not have it forked already:

    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. Check out a new branch, and add your contributions.

  3. If you added any new files, then ensure they are included in a reasonable spot in the repository’s nav.adoc configuration file

  4. Build locally and make sure everything looks the way you expect. See Building a local preview for instructions.

  5. Once you finish, commit your changes and push them to your fork.

  6. Use Pagure to make a pull request from your fork to the main repository’s master branch.

Managing your pull request

Someone will see your pull request and either merge it, or provide feedback if there is something you should change. Work with the people commenting to make sure your contributions are up to standards.

If nobody reacts to your pull request in several days, try bringing it up on one of the weekly meetings, the Matrix channel (#docs on Fedora Chat), or the forums.

Your changes will appear online sometime after the pull request is merged. The site is being updated every hour. If your changes do not appear online within 24 hours of your PR being merged, ping asamalik (Adam Šamalík) on the IRC channel and ask him about it.

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