• Stars
    star
    124
  • Rank 288,207 (Top 6 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created over 5 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Documentation, manual, instructions

Corteza technical and user documentation

Sources (most of it) for docs.cortezaproject.org website.

Authoring

Documentation is written in AsciiDoc format and processed with AsciiDoctor

Before you start, be sure you are familiar with syntax and formatting rules of AsciiDoc format.

  • 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

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

Building docker image

make image

Todo

  • Apply standard Corteza build pipeline