CSS HTML JavaScript Python Makefile Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
rudder-theme
src Merge branch 'branches/rudder/5.0' Aug 13, 2018
tests Fixes #13167: Broken link in dev doc after parent Aug 13, 2018
.gitignore Fixes #13110: Make different targets for docs Jul 31, 2018
LICENSE
Makefile Fixes #13140: Build a .htacces including redirect and cache instructions Aug 7, 2018
README.adoc Fixes #12907: Move reference manual to antora Jul 16, 2018
doc-5.0.yml Fixes #13115: Use tar.gz instead of zip Jul 31, 2018
doc-5.1.yml Fixes #13115: Use tar.gz instead of zip Jul 31, 2018
qa-test Fixes #12907: Move reference manual to antora Jul 16, 2018
requirements.txt
site-dev.yml Fixes #13126: Generate redirection info to latest stable doc Aug 1, 2018
site-local.yml Fixes #13126: Generate redirection info to latest stable doc Aug 1, 2018
site.yml Fixes #13126: Generate redirection info to latest stable doc Aug 1, 2018

README.adoc

Rudder documentation

Dependencies

Antora

https://docs.antora.org/antora/1.0/install/install-antora/ to build the doc

Graphviz

http://www.graphviz.org/ to build SVG schemas.

Pandoc

http://www.pandoc.org to convert ncf markdown doc to asciidoc

Python

to build generic methods documentation

For the tests only:

Linkchecker

http://wummel.github.io/linkchecker/ to check for broken links

Install the dependencies on Debian and Ubuntu:

apt install git linkchecker pandoc npm

Install the dependencies on Fedora

dnf install git linkchecker pandoc
# Install node and npm from upstream: https://nodejs.org/en/ (use LTS version)

Install common dependencies

On all systems:

npm i -g @antora/cli
npm i -g @antora/site-generator-default
npm i -g gulp-cli
npm i -g yarn

Build

Sources organization

  • rudder-theme: ui theme for the doc HTML output

  • src: contains the docs sources

    • get-started

    • rudder-by-example

    • reference

      • modules: contains the actual doc sources

      • dependencies: contains the doc built from external sources

      • tools: contaisn tools to help build the doc

      • antora.yml: entry point for antora

  • tests: contains test for the doc

  • build: contains built files

  • site.yml: main entry point for antora

Build site

Create HTML output suitable for distribution:

make

Output files will be in build/site.

Cleanup

Delete all generated files.

make clean

Theme development

Follow https://gitlab.com/antora/antora-ui-default/ for docs about the theme.