Migrate documentation to github pages (#1523)

Browse Source

Switch from having all documentation contained within the README to
publishing a jekyll static site of documentation under github pages.

This allows for configuration and installation guides to be handled
separately to make for the relevant pieces to be in smaller chunks and
therefore easier to follow for users. Additionally a table of contents
can now be included in a left navigation section that ensures it should
be possible to quickly jump from the start to any section and back
again.

Include support for publishing previews and releases under separate
directories to allow for them to exist at the same time as the other
latest version of the documents.

The navigation section also includes support for accessing any of the
other versions published so that it easier to see what configuration
options exist for a given release. These will be published automatically
when releases are added.

...

This commit is contained in:

Darragh Bailey

2022-07-19 14:48:02 +01:00

committed by GitHub

parent 206a9244a8

commit 82202945ce

28 changed files with 3353 additions and 2072 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

BIN

docs/_assets/images/logo.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 60 KiB