Contribua para as Documentações Rápidas

Esse repositório representa documentos asciidoc grosseiramente (semi-automaticamente) convertidos a partir das top 50 páginas similares a documentos na Fedora Wiki. Nós queremos nos afastar de expor os usuários ao território selvagem das wikis de locais de trabalho para um formato agradável, orientado à tópicos com um fluxo de trabalho baseado em pull request.

Então, esse projeto é um projeto ainda em estágio inicial. A sua ajuda é necessária!

Outras Fontes de Material

Existe uma categoria How To na wiki. Muitos desses documentos estão aptos à conversão. Perguntas populares no Ask Fedora também podem ser pontos de partida úteis – ou, também, as mais frequentes perguntas sobre o Fedora no Stack Exchange.

Ou, claro, se há algo que você se importa e que possa ajudar explicando, você pode criar um novo documento do zero.

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), e execute ./build.sh && ./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.

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 tornando obsoleta:

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

Naturalmente, você vai querer trocar aquela URL especifíca com a da sua nova página de destino. A URL não pode ser algo arbitrário — ela precisa de começar com https://docs.fedoraproject.org/.

Assim que o redirecionamento estiver feito, visitantes àquela página da wiki serão instantaneamente transportados (bem, redirecionados, com o código 301 Moved Permanently) para o site dos docs. Se você precisa editar tal página para corrigir a URL, ou remover o redirecionamento por completo, use um formulário como: https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

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.