An den Kurzanleitungen mitarbeiten

Sie werden charakterisiert durch

Sie werden charakterisiert durch

Falls Ihr Beitrag in keine der beiden Kategorien passt, versuchen Sie es doch mit einem Artikel unter „Administrationswerkzeuge“ oder auf der Startseite. Am besten stellen Sie Ihre Frage im Forum discussion.fedoraproject.org #docs.

Die größte Möglichkeit, einen Beitrag zu leisten, ergibt sich bereits beim Lesen des Artikels selbst. Sollten Sie auf einen Fehler, eine Auslassung oder eine unklare Formulierung stoßen, können Sie ganz nebenbei einen Verbesserungsvorschlag einbringen. In der Kopfzeile jedes Artikels finden Sie Links zu zwei der drei Werkzeuge für Beiträge.

Über den Knopf ganz rechts gelangt man zu einem Ticketsystem, in dem man das Problem schildern kann.

Das Subject-Feld enthält bereits einen Link zum betroffenen Dokument. Bitte ändern Sie diesen nicht. Beschreiben Sie bitte das Problem und geben Sie nach Möglichkeit einen kurzen Änderungsvorschlag an, der idealerweise zum Kopieren und Einfügen geeignet ist.

Falls Sie nicht bei pagure angemeldet sind, öffnet sich zunächst ein FAS-Anmeldefenster.

Der zweite Link öffnet einen Web-Editor, mit dem Sie Änderungsvorschläge direkt in den Text eingeben können.

Die nächsten Schritte werden im Detail im Artikel Bearbeiten von Dateien in der Pagure-Web-UI erläutert.

Sie können notwendige Änderungen finden und dazu beitragen, indem Sie dem Quick Docs Issue Board folgen, wo Benutzer Fehler in der Dokumentation melden oder Verbesserungsvorschläge einbringen.

Wenn Sie ein Problem finden, das Ihren Interessen und Fachkenntnissen entspricht, klicken Sie oben rechts auf den Link take, um sich das Problem selbst zuzuweisen.

In beiden Fällen folgt der Arbeitsablauf dem Modell von „Pull Requests“ oder „Merge Requests“. Änderungen werden nicht im bestehenden, veröffentlichten Text, sondern in einer separaten Version vorgenommen. Nach Abschluss der Arbeiten wird ein „Merge Request“ ausgelöst. Mitglieder der Community prüfen die Änderungen und diskutieren diese entweder oder akzeptieren sie. Anschließend werden sie in die veröffentlichte Version integriert. Wir befolgen somit das Vier-Augen-Prinzip.

Pull Requests fördern den kollaborativen Arbeitsablauf zwischen Autoren und Reviewern, wobei PR-Kommentare, Bearbeitungen und Commits als Review-Prozess dienen.

Die einzelnen Schritte laufen weitgehend automatisch ab. Details sind in den jeweiligen Werkzeugen beschrieben.

Sie möchten wahrscheinlich den weiteren Fortschritt nach dem Pull Request verfolgen. Genau dafür ist die Watch-Funktion gedacht.

„Watch status“ in der Mitte des Quick Doc-Berichts bietet vier Optionen. Wählen Sie eine der unten stehenden Optionen aus.

Die Benachrichtigung wird an Ihre E-Mail-Adresse gesendet, wie in den Benutzereinstellungen von Pagure hinterlegt.

Sollten Sie nach Ihrem Pull Request länger als eine Woche keine Rückmeldung von den Reviewern erhalten, hinterlassen Sie bitte einen Kommentar im Pull Request, um nachzufassen.

Anstatt sich auf die Konsistenz der Wortwahl und grammatikalische Fehler zu konzentrieren, ermutigen die Gutachter die Autoren, die Stilrichtlinien für die Dokumentation zu lesen. Für automatisierte Tests kann der Vale-Linter lokal ausgeführt werden (siehe Ihre Dokumentation mit Vale überprüfen).

Neben den Stilrichtlinien gibt es hier einige Regelwerke, die Mitwirkende beachten sollten.