Home

SUSE Manager Documentation Wiki

Table of Contents

• Welcome!
• Our Toolchain
  • Introduction
  • Setup the Toolchain (Manual Method - Default)
  • Alternative Method (Docker - Coming soon)
  • Having Trouble?
  • Publishing Content
• 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 the Toolchain (Manual Method - Default)

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. Useful for updates to antora.

3. Install Asciidoctor Gems

   Upstream gems for our adoc and pdf outputs.

4. Install Antora

   Upstream tool for generating our static HTML documentation pages.

5. Install the Lunr Module

   This module is maintained by upstream Dan Allen and Guillaume Grossetie. When you run make antora-suma this module builds a lunrjs index for use with search.

6. How to Build Docs

Alternative Method (Docker - 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

1. Setup Docker for Antora

Having Trouble?

• Troubleshooting Common Errors

Publishing Content

Publish documentation to our end points.

• Publishing to OBS

• Publishing Enterprise Documentation

• Publishing on Github Pages

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.

• Getting Started with Asciidoc - Syntax and Best practice for Contributors) Update coming soon! jcayouette July 11, 2019

• Asciidoc Syntax Quick Reference

• Asciidoctor Writer’s Guide

• Asciidoctor User’s Manual

Latest Projects

• Branding Guide - In progress July 23, 2019

• Information Architecture Rework 2018 - 2019

• Setup Algolia Search with Antora TODO: needs an update for uyuni/suma/susecom

Resources

• YAML Documentation

• TravisCI Documentation

• Algolia Documenation