-
Notifications
You must be signed in to change notification settings - Fork 34
Home
This is the official wiki for SUSE Manager documentation.
A development update of this section is in progress! jcayouette July 11, 2019
We use a combination of the following tools to publish and build our documentation:
Asciidoctor A fast text processor and publishing toolchain for converting AsciiDoc to HTML5, DocBook and more.
Asciidoctor PDF Asciidoctor PDF is a native PDF converter for AsciiDoc.
Antora The multi-repository documentation site generator.
Want to help improve our documentation? The following guides will get your development environment up and running:
-
Easily manage your Ruby versions and gems with rbenv
-
Easily manage your node package versions with the Node Version Manager.
-
Upstream tool for generating our static HTML documentation pages.
-
Upstream gems for our adoc and pdf outputs.
-
How to build our docs, tips and some gotchas.
Publish documentation to our end points.
Have a look at our syntax guide and expectations. We have also listed the official documentation for asciidoctor for those interested in digging a little deeper.
-
Getting Started with Asciidoc - Syntax and Best practice for Contributors) Update coming soon! jcayouette July 11, 2019
-
Setup Algolia Search with Antora TODO: needs an update for uyuni/suma/susecom
Setup and Build
- Setup rbenv and Ruby
- Install nvm
- Install Antora
- Install Asciidoctor Gems
- Building the Docs
- Optional Tools
How to Publish
Publish to OBS
Publish Enterprise Docs
Publishing to Github Pages
Want to Help?
Get Started with Asciidoc
Quick Syntax Reference
Asciidoctor Writer's Guide
Asciidoctor User's Manual
Resources
YAML Documentation