Zu den Kurzanleitungen beitragen

Das Fedora-Dokumentationsteam Version all versions Last review: 2023-08-25
Ziel ist es, von Wikis, in denen hilfreiche Anleitungen mit Entwürfen und internen Notizen vermischt sind, zu übersichtlichen, themenorientierten Anleitungen und Code-Tutorials mit einem „Pull-Request“-basierten Arbeitsablauf überzugehen. Wir freuen uns über Ihre Unterstützung!

Schritte

  1. Wählen Sie ein Dokument aus, das aktualisiert werden soll. Dokumente, die aktualisiert werden müssen, finden Sie in der Datei modules/ROOT/nav.adoc. Sie befinden sich in den auskommentierten Zeilen (die mit //FIXME beginnen).

  2. Fork the https://forge.fedoraproject.org/docs/quick-docs repo.

  3. Nehmen Sie die gewünschten Änderungen an der .adoc-Datei vor.

  4. Entfernen Sie die Kommentarzeichen vor der Datei in nav.adoc und entfernen Sie das FIXME aus dem xref.

  5. Um sicherzustellen, dass Ihre Änderungen wie gewünscht aussehen, erstellen Sie eine lokale Vorschau. Stellen Sie sicher, dass Podman oder Docker installiert ist. Führen Sie auf einem Linux-Desktop ./docsbuilder.sh aus. Führen Sie auf macOS entweder ./docsbuilder.sh -p oder ./preview.sh aus. Befolgen Sie die Anweisungen in der Befehlszeile.

  6. Wenn Sie mit Ihren Aktualisierungen zufrieden sind, reichen Sie einen „Pull Request“ mit Ihren Verbesserungen ein.

  7. Wenn Sie eine Wiki-Seite migrieren, erstellen Sie eine Weiterleitung auf der alten Seite – siehe unten.

Mögliche Quellen

Vielleicht möchten Sie einfach nur ein bestehendes Dokument verbessern; in diesem Fall benötigen Sie nichts weiter. Oder Sie haben bereits eine konkrete Idee. Falls Sie jedoch helfen möchten, aber nicht wissen, wo Sie anfangen sollen, finden Sie hier einige Anregungen:

  • Die alte How-To-Kategorie im Fedora-Wiki. Viele der dort enthaltenen Dokumente eignen sich hervorragend für eine Konvertierung. (Viele sind allerdings auch stark veraltet!)

  • Die Fragen in Common Issues in Ask Fedora.

  • Häufig gestellte Fragen zu Fedora auf Stack Exchange.

  • Die Artikel im Fedora Magazine sind im lockeren Konversationsstil gehalten und geben einen aktuellen Stand wieder. Die Versionen für die Kurzanleitungen (Quick Docs) sollten prägnanter sein und bei Änderungen von Befehlen oder Best Practices aktualisiert werden.

Wiki-Weiterleitungen

Normalerweise erlauben Wikis keine Weiterleitungen zu externen Seiten, da das Missbrauchspotenzial sehr hoch ist. Wir haben ein Plugin für das Fedora Wiki entwickelt, das Weiterleitungen ausschließlich zu Seiten dieser Website (https://docs.fedoraproject.org/) ermöglicht. Um einen solchen Link zu erstellen, verwenden Sie das Makro #fedoradocs, indem Sie beispielsweise folgenden Code am Anfang der zu ersetzenden Wiki-Seite einfügen:

{{#fedoradocs: https://docs.fedoraproject.org/de/council/fpl/}}

Selbstverständlich sollten Sie die Beispiel-URL durch die URL Ihrer neuen Zielseite ersetzen. Auch hier gilt: Die URL darf nicht beliebig sein, sie muss mit https://docs.fedoraproject.org/ beginnen.

Sobald die Weiterleitung eingerichtet ist, werden Besucher dieser Wiki-Seite sofort (bzw. mit dem Code 301 Moved Permanently) auf die Dokumentationsseite weitergeleitet.

Beachten Sie, dass nicht geprüft wird, ob das Ziel existiert oder korrekt ist – überprüfen Sie daher bitte alle von Ihnen erstellten Weiterleitungen sorgfältig, bevor Sie fortfahren.

Wenn Sie eine solche Seite bearbeiten müssen, um die URL zu korrigieren oder die Weiterleitung aus irgendeinem Grund zu entfernen, erstellen Sie eine Wiki-Site-URL mit &action=edit, wie zum Beispiel:

https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

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