From 81eb67a23efc59a17e08c42f7c62c28f66d79a9e Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Sep 15 2019 09:14:53 +0000 Subject: Add a REAMDE file describing a bit the project Signed-off-by: Pierre-Yves Chibon --- diff --git a/README.md b/README.md new file mode 100644 index 0000000..b0a76d8 --- /dev/null +++ b/README.md @@ -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