docs/README.md

24 lines
715 B
Markdown
Raw Normal View History

# CPE Documentation
This repository contains documentation related to the Community Platform
Engineering (CPE) team at Red Hat.
It aims at providing you information on who we are, what we do and how we work
within the team as well as with you.
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