Contribuir a Quick Docs

Este repositorio representa asciidoc documentos aproximadamente convertidos (semiautomáticamente) a partir de las 50 principales páginas similares a documentos en la Fedora Wiki. Queremos dejar de exponer a los usuarios al territorio salvaje de los wikis del espacio de trabajo y adoptar un formato agradable y orientado a temas con un flujo de trabajo basado en relaciones públicas..

De modo que, esto es una especia de proyecto semilla. ¡Queremos tu ayuda!

Otro Material Fuente

En la wiki hay una Categoria How To. Muchos de esos documentos están maduros para su conversión. Preguntas populares sobre Ask Fedora es probable que también sean puntos de partida útiles — o, también, frecuentes Preguntas de Fedora en Stack Exchange.

O, desde luego, si hay algo que le interese y que pueda ayudar a explicar puede crear un documento desde cero.

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.

Wiki Redirects

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 obsoleting:

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

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

Once the redirect is in place, visitors to that wiki page will be instantly whisked (well, redirected, with the code 301 Moved Permanently) to the docs site. If you need to edit such a page to correct the URL, or to remove the redirect completely, use a form like: https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

Note that there is no validation that the target exists or is correct — please double-check that any redirects you create work properly before moving on.