Infrastructure/infra-docs-fpo
3
0
Fork 0
Code Issues 100 Pull requests 6 Projects Releases Packages Wiki Activity Actions

Update the readme

Browse source 
Previously the readme referred to the old infra-docs repo as the source
of internal docs and infra-docs-fpo for user-facing. This is clearly
wrong now, so rewroite the readme to say that.

also put a link in to the built docs which is handy

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
This commit is contained in:
Ryan Lercho 2021-11-10 19:20:56 +10:00
parent 1d7790ce3c
commit f8af7bc491
1 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,12 +1,14 @@
# infr-docs Documentation
# Fedora Infrastructure Documentation
This repository contains documentation related to the Fedora Infrastructure
This repository contains the sources for the documentation related to the Fedora Infrastructure
team.
The documentation of the Fedora Infrastructure is divided into two parts:
- The end-user oriented documentation, this project: https://pagure.io/infra-docs-fpo
- The internal documentation, containing SOPs and all: https://pagure.io/infra-docs
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:
@ -16,10 +18,16 @@ $ ./build.sh && ./preview.sh
The result will be available at http://localhost:8080
Some resources to help you get started with asciidoc:
## 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