Mitarbeiten an den Veröffentlichungshinweisen

Fedora-Dokumentationsteam <https://discussion.fedoraproject.org/tag/docs> v0.0.1, 26. September 2022

Dieser Abschnitt beschreibt, wie Sie zu den Fedora-Veröffentlichungshinweisen beitragen können. Bevor Sie damit beginnen, stellen Sie sicher, dass Sie alle Voraussetzungen erfüllen.

Der Prozess zur Mitarbeit an den Versionshinweisen befindet sich auf einer separaten Seite, da er sich von der übrigen Fedora-Dokumentation unterscheidet. Wenn Sie an der Mitarbeit an anderen Dokumenten interessiert sind, besuchen Sie bitte die entsprechende Seite.

Die Veröffentlichungshinweise sind insofern einzigartig, als sie – anders als alle anderen Dokumente – für jede neue Veröffentlichung nahezu vollständig neu erstellt werden, während alle anderen Dokumente zwischen den Veröffentlichungen lediglich aktualisiert werden. Das bedeutet, dass sich einige Teile des unten beschriebenen Verfahrens, wie beispielsweise der verwendete Git-Zweig oder der Zeitplan, mit jeder neuen Veröffentlichung ändern. Bevor Sie mit dem Schreiben der Veröffentlichungshinweise beginnen, lesen Sie bitte den #docs-Tag im Fedora-Diskussionsforum, insbesondere die Seitenleiste rechts. Dort finden Sie aktuelle Informationen.

Zu den Fedora-Veröffentlichungshinweisen beitragen

  1. Schauen Sie in der Seitenleiste auf Fedora Discussion und beachten Sie die dort angegebenen Informationen: Release, Zeitplan, Zweig und Link zur Liste der relevanten Probleme.

  2. Wählen Sie aus der Liste der offenen und nicht zugewiesenen Probleme für die Veröffentlichung ein oder mehrere Probleme aus, zu deren Behebung Sie beitragen möchten.

  3. Öffnen Sie jede von Ihnen ausgewählte Ausgabe und klicken Sie auf den Knopf „Take“ auf der rechten Seite, um sie zu übernehmen.

    Wenn Sie ein Problem übernehmen, aber später feststellen, dass Sie keine Zeit haben, es zu beenden, entfernen Sie sich so schnell wie möglich aus der Bearbeitung des Problems, damit jemand anderes es übernehmen kann.

  4. Informieren Sie sich über Ihr Problem. Viele Einträge enthalten bereits umfangreiche Informationen, insbesondere im verlinkten Wiki. Falls Sie weitere Informationen benötigen, finden Sie heraus, wer für die Änderung verantwortlich ist (ebenfalls auf der im Eintrag verlinkten Wiki-Seite aufgeführt) und erwähnen Sie diese Person in den Kommentaren des Eintrags mit @ oder kontaktieren Sie sie per IRC/Matrix oder E-Mail. Denken Sie daran, dass es immer besser ist, zu recherchieren, bevor Sie Fragen stellen. Beachten Sie, dass Sie den Verantwortlichen möglicherweise nicht innerhalb eines angemessenen Zeitraums erreichen können. Geben Sie in diesem Fall einfach Ihr Bestes. Sollte sich etwas als falsch erweisen, können wir es später jederzeit korrigieren.

  5. Verfassen Sie einen Veröffentlichungshinweis zu diesem Problem. Falls Sie sich nicht sicher sind, wie ein Veröffentlichungshinweis aussehen sollte, finden Sie Beispiele vorherigen Versionen. Wir bitten Sie, keine langen, zu technischen Texte zu verfassen. Veröffentlichungshinweise sollen in der Regel Änderungen hervorheben und nicht die Verwendung erklären.

  6. Der Arbeitsablauf variiert nun je nach Ihren Zugriffsrechten auf Pagure und Ihren technischen Fähigkeiten:

    • Wenn Sie mit Git und ASCIIDoc vertraut sind, verfassen Sie die Veröffentlichungshinweise und senden Sie einen Pull Request an das Haupt-Repository. Achten Sie darauf, den Pull Request im richtigen Zweig zu öffnen, nicht im Zweig main – siehe ersten Schritt dieser Anleitung für weitere Informationen. (Der Zweig main dient lediglich als Vorlage für jede neue Veröffentlichung und enthält daher nur eine leere Struktur und einige Seiten, die sich zwischen den Veröffentlichungen nicht ändern.) Ihre Beiträge gehören in eine der Dateien unter modules/release-notes/pages/. Welche Datei, hängt vom Inhalt der zu dokumentierenden Änderung ab.

Falls Sie den Abschnitt, in dem Sie Ihre Beiträge hinzugefügt haben, überhaupt nicht sehen können, stellen Sie sicher, dass er im Inhaltsverzeichnis in modules/release-notes/nav.adoc enthalten ist.

+ * Falls Ihnen das oben Genannte unverständlich erscheint, ist das kein Problem. Hinterlassen Sie einfach einen Kommentar mit Ihrem Text im entsprechenden Ticket. Jemand wird ihn dann korrigieren und in das endgültige Dokument einfügen.

Wiederholen Sie die obigen Schritte für beliebig viele Probleme.

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