Contributor facing documentation for the Fedora Infrastructure
2bb2853ec5
This kinda isn't even an SOP any more, because no manual action is needed in the ordinary course of events any more. We could, I guess, just remove it. But this instead rewrites it to kinda explain the process in case manual intervention is needed. The current information is entirely outdated. Signed-off-by: Adam Williamson <awilliam@redhat.com> |
||
|---|---|---|
| modules | ||
| .gitignore | ||
| antora.yml | ||
| build.sh | ||
| LICENSE | ||
| preview.sh | ||
| README.md | ||
| site.yml | ||
Fedora Infrastructure Documentation
This repository contains the sources for the documentation related to the Fedora Infrastructure team.
The Documentation is built and available to read on the Fedora Documentation site at:
https://docs.fedoraproject.org/en-US/infra/
Previewing the documentation
To build and preview the site, run:
$ ./build.sh && ./preview.sh
The result will be available at http://localhost:8080
Writing the documentation
The Fedora Infrastructure Documentation uses asciidoc as the source markup.
Below are some resources to help you get started with asciidoc:
- asciidoc syntax cheatsheet: https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
- asciidoc full user manual: https://asciidoctor.org/docs/user-manual/
- Antora's documentation: https://docs.antora.org/antora/2.0/
License
This documentation is made available under CC-BY-SA 3.0