Contribute to Quick Docs

This repository represents asciidoc documents roughly (semi-automatically) converted from the top 50 document-like pages in the Fedora Wiki. We want to move away from exposing users to the wild territory of workspace wikis and to a nice, topic-oriented format with a PR-based workflow.

So, this is kind of a seed project. Your help wanted!

Other Source Material

There is a How To category on the wiki. Many of those documents are ripe for conversion. Popular questions on Ask Fedora are also likely to be useful starting points — or, also, frequent Fedora questions on Stack Exchange.

Or, of course, if there’s something you care about which you can help explain, you can create a new document from scratch.

Steps

  1. Pick a document to update. You can find documents needing updates in the modules/ROOT/nav.adoc file. They are on the commented-out lines (those that start with a //FIXME).

  2. Fork the https://pagure.io/fedora-docs/quick-docs repo.

  3. Make your changes to the .adoc file you want to improve.

  4. Uncomment the file in nav.adoc remove the FIXME from the xref..

  5. Build a local preview to ensure your changes look the way you intended: Make sure you either have Podman or Docker installed, and run ./build.sh && ./preview.sh. Follow instructions printed on the command line.

  6. When you are satisfied with your updates, submit a pull request with your improvements.

  7. If migrating a wiki page, create a redirect on the old page — see below.

Redirection du Wiki

Habituellement, les wikis ne permettent pas de rediriger vers des sites externes, car le risque d’abus est très élevé. Nous avons développé un greffon pour le wiki Fedora qui permet des redirections vers des pages de ce site seulement, https://docs.fedoraproject.org/. Pour créer un tel lien, utilisez la macro #fedoradocs en mettant quelque chose comme ceci en haut de la page du wiki que vous rendez obsolète :

{{#fedoradocs: https://docs.fedoraproject.org/fedora-project/council/fpl.html}}

Bien entendu, vous voudrez remplacer cette URL spécifique par celle de votre nouvelle page cible. L’URL ne peut pas être quelque chose d’arbitraire — elle doit commencer par https://docs.fedoraproject.org/.

Une fois la redirection en place, les visiteurs de cette page wiki seront instantanément dirigés (enfin, redirigés, avec le code 301 Moved Permanently) vers le site de la documentation. Si vous avez besoin de modifier une telle page pour corriger l’URL, ou pour supprimer complètement la redirection, utilisez une URL comme : https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

Veuillez noter qu’il n’y a pas de validation de l’existence ou de l’exactitude de la cible, veillez donc à vérifier que les redirections que vous créez fonctionnent correctement avant de passer à autre chose.