infra-docs-fpo/README.md

# 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