24ed33ef98
There's currently an `sop.adoc` page which looks like a bad wiki conversion of a list of links to the miscellaneous SOPs. We already have `index.adoc` as a *working* list of links to the miscellaneous SOPs, so this is pretty redundant, let's just drop it. Also dropped: sop_update_releng_docs , which is entirely outdated. Also, make `index.adoc` and the nav sidebar link to the sigul client setup SOP which they're currently missing, and update the SOP template page a bit. Signed-off-by: Adam Williamson <awilliam@redhat.com> |
||
|---|---|---|
| modules | ||
| .gitignore | ||
| antora.yml | ||
| docsbuilder.sh | ||
| LICENSE | ||
| nginx.conf | ||
| 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/
Local preview
This repo includes a script to build and preview the contents of this repository.
NOTE: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see the Fedora Docs build repository for instructions.
The script works on Fedora (using Podman or Docker) and macOS (using Docker).
To build and preview the site, run:
$ ./docsbuilder.sh -p
The result will be available at http://localhost:8080
To stop the preview:
$ ./docsbuilder.sh -k
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