Add a REAMDE file describing a bit the project
Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>
This commit is contained in:
parent
0f723c2884
commit
81eb67a23e
1 changed files with 25 additions and 0 deletions
25
README.md
Normal file
25
README.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
# infr-docs Documentation
|
||||
|
||||
This repository contains 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
|
||||
|
||||
|
||||
|
||||
To build and preview the site, run:
|
||||
|
||||
```
|
||||
$ ./build.sh && ./preview.sh
|
||||
```
|
||||
|
||||
The result will be available at http://localhost:8080
|
||||
|
||||
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/
|
||||
|
||||
This documentation is made available under CC-BY-SA 3.0
|
Loading…
Add table
Add a link
Reference in a new issue