Welcome
This handbook is how we write, build, and publish documentation for two products that share one toolchain:
- SUSE Multi-Linux Manager — enterprise docs on documentation.suse.com
- Uyuni — open-source community docs on uyuni-project.org
How this handbook is organized
| Section | What it is for |
|---|---|
| Contribute | Fork, branch, sign commits, and open a pull request |
| Set up | Container, Task, WSL2, VS Code |
| Build and publish | config.yml, then MLM (enterprise) or Uyuni (community) |
| Tools | AsciiDoc, Antora, Task, and the other tools we use |
Our Documentation Ecosystem
The Uyuni documentation ecosystem is built on established tools and practices used across the open source and enterprise documentation landscape.
Content Creation
- AsciiDoc markup language for writing structured technical documentation
- Semantic markup for modular and reusable content
- Cross-references, includes, and topic-based organization
Build and Publishing
- Antora static site generator for multi-repository documentation
- Automated builds and continuous integration workflows
- Version management and controlled release processes
Localization and Translation
- AI translation against the manager-5.1 and manager-5.2 branches, delivered as pull requests
Start with Contribution workflow and Container setup.