Corteza technical and user documentation

Sources (most of it) for http://docs.cortezaproject.org[docs.cortezaproject.org] website.

== Authoring

Documentation is written in https://asciidoctor.org/docs/what-is-asciidoc/[AsciiDoc] format and processed with https://asciidoctor.org/[AsciiDoctor]

Before you start, be sure you are familiar with https://asciidoctor.org/docs/asciidoc-writers-guide/[syntax and formatting] rules of AsciiDoc format.

.https://asciidoctor.org/docs/asciidoc-recommended-practices/[Rules to follow]:

• One sentence per line.
• Atx-style section titles

and other recommended practices from the linked page

=== Structure

Documentation is divided into 6 major chapters:

• overview
• releases
• user manual
• extending
• maintainer
• core developer
• system management

=== Building files directly

[source,shell]

docker run -u $(id -u) -v $PWD:/antora:Z --rm -t antora/antora --cache-dir=./.cache/antora --stacktrace antora-playbook.yml

=== Building docker image

[source,shell]

make image

=== Todo

• Apply standard Corteza build pipeline