Home

SUSE Manager Documentation Wiki

Table of Contents

Welcome!
Our Toolchain
Want to Help?
Latest Projects
Resources

Welcome!

This is the official wiki for SUSE Manager documentation.

Our Toolchain

A development update of this section is in progress! jcayouette July 11, 2019

Introduction

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.

Setup and Build (Manual Method - Default)

Want to help improve our documentation? The following guides will get your development environment up and running:

Procedure: Setup The Toolchain

Setup rbenv and Ruby

Easily manage your Ruby versions and gems with rbenv
Install NVM

Easily manage your node package versions with the Node Version Manager.
Install Antora

Upstream tool for generating our static HTML documentation pages.
Install Asciidoctor Gems

Upstream gems for our adoc and pdf outputs.
How to Build Docs

How to build our docs, tips and some gotchas.

Setup and Build Alternative Method (Coming soon)

You can skip the above installation path and use docker. This simplifies setup but this option will remain unavailable until lunrjs is integrated into the upstream docker containers. Coming soon! (I do not want to maintain containers.) For the docker installation you only need docker and the upstream antora and asciidoctor images pulled from docker hub.

Procedure: Configuring Docker with Antora and Asciidoctor

Setup Docker for Antora

Having Trouble?

Troubleshooting Common Errors

Publishing Content

Publish documentation to our end points.

Want to Help?

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.