Skip to content
Joseph Cayouette edited this page Sep 3, 2019 · 91 revisions

SUSE Manager Documentation Wiki

Welcome!

This is the official wiki for SUSE Manager documentation.

Our Toolchain

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)

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

Procedure: Setup The Toolchain
  1. Setup rbenv and Ruby

    Easily manage your Ruby versions and gems with rbenv

  2. Install NVM

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

  3. Install Antora

    Upstream tool for generating our static HTML documentation pages.

  4. Install Asciidoctor Gems

    Upstream gems for our adoc and pdf outputs.

  5. How to Build Docs

    How to build our docs, tips and some gotchas.

  6. Optional Tools

    List of optional tools that work with our toolchain.

Clone this wiki locally
You can’t perform that action at this time.