Home

SUSE Manager Documentation Wiki

Table of Contents

• Welcome!
• Want to Help?
• Our Toolchain
  • Introduction
  • Setup the Toolchain
  • Having Trouble?
  • Publishing Content
• Latest Projects
• Resources

Welcome!

This is the official wiki for SUSE Manager documentation.

Want to Help?

Have a look at our syntax guide and expectations. We have also listed the official documentation for asciidoctor for digging deeper. Have a look at the next section for guidance on Our Toolchain.

• Getting Started with Asciidoc - Syntax and Best practice for Contributors)

• Asciidoc Syntax Quick Reference

• Asciidoctor Writer’s Guide

• Asciidoctor User’s Manual

Our Toolchain

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. Installed via a Ruby gem and rbenv.

Asciidoctor PDF Asciidoctor PDF is a native PDF converter for AsciiDoc. Installed via a Ruby gem and rbenv.

Antora The multi-repository documentation site generator. We use the official Antora docker container as it simplifies your requirements.

Setup the Toolchain

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

Procedure: Setup The Toolchain

1. Setup Ruby and rbenv

2. Install Asciidoctor and Asciidoctor PDF Gems

3. Setup Docker for Antora

4. How to Build Docs

Having Trouble?

• Troubleshooting Common Errors

Publishing Content

Publish documentation to our end points.

• Publishing to OBS

• Publishing to Enterprise Endpoints

• Publishing to Master Branches on Github Pages

Latest Projects

• 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