Skip to content
This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

Home

Jump to bottom
Joseph Cayouette edited this page Aug 8, 2019 · 94 revisions

SUSE Manager Documentation Wiki

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 Ruby and rbenv - Easily manage your Ruby versions

  2. Install Node Version Manager - Easily manage your node package versions. Useful for updates to antora.

  3. Install Asciidoctor and Asciidoctor PDF Gems - Upstream gems for our adoc and pdf outputs.

  4. Install Antora the Static Site Generator - Upstream tool for generating our static HTML documentation pages.

  5. Install the antora-site-generator-lunr Node Module - This module is maintained by upstream Dan Allen and Guillaume Grossetie. When calling a for a new build 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

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.

Home

Setup and Build

  1. Setup rbenv and Ruby
  2. Install nvm
  3. Install Antora
  4. Install Asciidoctor Gems
  5. Building the Docs
  6. 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

Clone this wiki locally