Home

Uyuni Documentation Wiki

Table of Contents

• Welcome!
• In our community and wish to contribute?
• For SUSE writers
  • Writing style expectations
  • Setup the toolchain
  • Building documentation
  • Packaging

Welcome!

This is the official wiki for Uyuni and SUSE Manager documentation. Use the sidebar for common tasks.

In our community and wish to contribute?

1. Clone the repository:

   git clone https://github.com/uyuni-project/uyuni-docs.git

2. Create your own branch:

   git checkout -b my-custom-branch

3. Setup our toolchain

4. Building and testing docs

5. Create a pull request for review

For SUSE writers

Writing style expectations

Writing and word usage guide
Getting started with Asciidoc

Setup the toolchain

• Setup our toolchain

Building documentation

uyuni
suma

Packaging

uyuni
suma

Preparing a Pull Request

See Main repository README

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. Install po4a

   We use po4a to convert docs to gettext and back for translation.

6. How to Build Docs

   How to build our docs, tips and some gotchas.

7. Optional Tools