Contribua para as Documentações Rápidas

A Equipe do Fedora Docs. Versão all versions Last review: 2023-08-25
O objetivo é abandonar os wikis, onde guias úteis são misturados com rascunhos de documentação e notas internas, e adotar guias práticos e tutoriais interessantes, orientados a tópicos específicos, repletos de código e com um fluxo de trabalho baseado em solicitações pull. Agradecemos a sua ajuda!

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. Crie uma prévia local para garantir que as suas mudanças estejam como você pretendia. Certifique-se de que você tenha ou o Podman ou o Docker instalado(s), no Linux execute ./docsbuilder.sh e ./docsbuilder.sh -p ou ./preview.sh. Siga as instruções indicadas na linha de comando.

  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.

Possíveis Fontes de Material

Talvez você queira apenas aprimorar um documento existente e, nesse caso, tudo o que precisa é o acima. Ou talvez você já tenha algo em mente. Mas se você tem interesse em ajudar, mas não sabe por onde começar, aqui estão alguns lugares para buscar ideias:

Redirecionamentos da Wiki

Normalmente, as wikis não permitem redirecionamento para sites externos, por conta do potencial para abuso ser muito elevado. Nós desenvolvemos um plugin para a Fedora Wiki que permite redirecionamentos apenas para páginas nesse site, https://docs.fedoraproject.org/. Para criar um tal link, use a macro #fedoradocs colocando algo como isso no topo da página da wiki que você estiver substituindo:

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

Naturalmente, você deve substituir aquele exemplo de URL com a da sua nova página de destino. Novamente, a URL não pode ser algo arbitrário, ela precisa de começar com 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 ›