Documents rapides Fedora

Ce dépôt comprend les documents asciidoc convertis approximativement (semi-automatiquement) à partir des 50 premières pages de type documentaire du Wiki Fedora. Nous voulons cesser d’exposer les utilisateurs au territoire sauvage des wikis de l’espace de travail et passer à un format agréable, axé sur le sujet, avec un flux de travail basé sur les demandes de tirage.

Il s’agit donc d’une sorte de projet d’amorçage. Votre aide est la bienvenue !

Autres sources d’information

Il existe une catégorie How To sur le Wiki. Beaucoup de ces documents sont prêts pour à être convertis. Les questions populaires sur Ask Fedora ainsi que les questions fréquentes sur Stack Exchange sont susceptibles d’être des points de départ utiles.

Ou, bien sûr, s’il y a quelque chose qui vous tient à cœur et que vous pouvez aider à expliquer, vous pouvez créer un nouveau document à partir de zéro.

Étapes

  1. Choisissez un document à mettre à jour. Vous trouverez les documents à mettre à jour dans le fichier modules/ROOT/nav.adoc. Ils se trouvent sur dans les lignes commentées (celles qui commencent par un //FIXME).

  2. Dupliquez le dépôt https://pagure.io/fedora-docs/quick-docs.

  3. Apportez vos modifications au fichier .adoc que vous souhaitez améliorer.

  4. Décommentez le fichier dans nav.adoc et supprimez le FIXME du xref.

  5. Préparez un aperçu local pour vous assurer que vos changements sont conformes à vos attentes : assurez-vous que vous avez installé le Docker et exécutez ./build.sh && ./preview.sh. Suivez les instructions affichées sur la ligne de commande.

  6. Lorsque vous êtes satisfait avec vos modifications, soumettez une demande de tirage avec vos améliorations.

  7. Si vous migrez une page wiki, créez une redirection sur l’ancienne page — voir ci-dessous.

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.