Contribua para as Documentações Rápidas

The Fedora Docs Team. Versão all versions Last review: 2023-08-25
The goal is to move away from wikis, where helpful guides are mixed with draft documentation, internal notes, to a nice, topic-oriented how-to guides and code-packed tutorials with a pull-request-based workflow. We appreciate your help!

Etapas

  1. Escolha um documento para ser atualizado. Você pode encontrar documentos precisando de atualização no arquivo modules/ROOT/nav.adoc. Eles estão nas linhas comentadas (as que começam com um //FIXME).

  2. Crie um fork do repositório https://pagure.io/fedora-docs/quick-docs.

  3. Faça suas mudanças para o arquivo .adoc que você queira melhorar.

  4. Descomente o arquivo em nav.adoc removendo o FIXME do xref.

  5. Build a local preview to ensure your changes look the way you intended: Make sure you either have Podman or Docker installed, On a Linux desktop run ./docsbuilder.sh. On macOS run either ./docsbuilder.sh -p or ./preview.sh. Follow instructions printed on the command line.

  6. Quando você estiver satisfeito com suas atualizações, faça um pull request com as suas melhorias.

  7. Se você estiver migrando uma página da wiki, crie um redirecionamento na página antiga – veja abaixo.

Possible Source Material

Perhaps you just want to improve an existing document, in which case the above is all you need. Or maybe you already have something in mind. But if you are interested in helping but don’t know where to start, here are some places to look for ideas:

  • The old How To category on the Fedora wiki. Many of those documents are ripe for conversion. (Many are also very out of date!)

  • Common Issues questions on Ask Fedora.

  • Frequent Fedora questions on Stack Exchange.

  • Fedora Magazine articles. The magazine format is conversational, and understood to represent a moment in time. Quick Docs versions should be more to-the-point, and kept updated if commands or best pratices change.

Redirecionamentos da Wiki

Usually, wikis do not allow redirects to external sites, because the potential for abuse is very high. We’ve developed a plugin for the Fedora Wiki which allows redirects to only pages on this site, https://docs.fedoraproject.org/. To create such a link, use the #fedoradocs macro by putting something like this at the top of the wiki page you are replacing:

{{#fedoradocs: https://docs.fedoraproject.org/en-US/council/fpl/}}

Of course, you should to replace that example URL with the one for your new target page. Again, the URL can’t be something arbitrary it must begin with https://docs.fedoraproject.org/.

Uma vez que o redirecionamento estiver em vigor, os visitantes dessa página da wiki serão imediatamente redirecionados (bem, redirecionados, com o código 301 Movido Permanentemente) para o site de documentação.

Observe que não há validação que o destino existe ou que ele é correto — por favor, verifique cuidadosamente que qualquer redirecionamento que você criar funciona devidamente antes de prosseguir.

Se você precisa editar uma página para corrigir a URL ou remover o redirecionamento por algum motivo, construa uma URL do site da wiki usando &action=edit, como:

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

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