Getting Started

Common workflow of documentation is:

Write -> Build -> Publish

Our workflow will be:

Write -> Build -> Translate -> Publish

Text Editor

There ara variuous tools for different platforms with RST support

• Online
• vim extension
• Notepad++
• Visual Studio Code

Build Tools

It’s all described in Sphinx. Sphinx package includes all tools to check and build the documents.

Translation Platform

In the chapter Zanata it’s described, how Zanata can help us to translate text strings in differenz languages.

Publishing

Compiled HTML pages can served on our own webserver (see LXD Container) Or we use the pretty online service Readthedocs)

LXD Container

To build our own sphinx build and translation platform, we simple use LXD Container. If your LXD environment is initialized, just do it:

lxc launch ubuntu:16.04 zanata
lxc exec zanata -- bash

Of course, any other Ubuntu system can be used.