Uyuni Documentation Repository

Statuses and Artifacts

This section provides the live status of GitHub Actions workflows for the Uyuni documentation. Each badge reflects the current state of automated builds, tests, and artifact generation across branches.

Build and Archive Workflows

Build workflows validate and archive documentation from both development and release branches.

Development Branches

The following branches are under active development and continuously tested:

master
manager-5.1
manager-5.0
manager-4.3

Release Branches

Release branches contain stable documentation builds: Builds and Artifacts

File and Content Validation

These workflows help maintain repository cleanliness and translation consistency.

Find Unused Files

This job identifies unused files in the documentation source:

master
manager-5.0
manager-4.3

Update Translation Files

This job updates translation templates for supported locales:

master

Test PDF Translations

This job tests PDF builds of translated documentation. NOTE: The en locale is excluded, as it is built as part of the Build and Archive Documentation from Branches workflow.

master
manager-4.3

Introduction

This repository contains the official Uyuni and SUSE Manager documentation. Contributions are welcome. Pull requests are encouraged.

For details on contributing, refer to the Uyuni Documentation Wiki. It provides guidance on terminology, markup conventions, processes, toolchain usage, local builds, publishing, and project planning.

First Contribution

Configure Git Commit Signing

Commit signing with a GPG or SSH key is required. Verified commits ensure authenticity. See the GitHub documentation for details.

Contributing Using a Fork

1. Ensure you have a GitHub account and are signed in.

2. Fork the repository: https://github.com/uyuni-project/uyuni-docs.git

3. Clone your fork:

   git clone https://github.com/<username>/uyuni-docs.git

4. Switch to the master branch:

   cd uyuni-docs
   git checkout master

5. Add the upstream repository:

   git remote add upstream https://github.com/uyuni-project/uyuni-docs.git

6. Fetch and merge changes from upstream regularly.

7. Create a feature branch for your work:

   git checkout -b update-readme-username

Contributing With Write Access

If you have direct write access, clone the repository, check out the master branch, and create feature branches as needed.

Committing Changes and Creating a Pull Request

1. Make and verify your changes locally.

2. Stage and commit files:

   git add .
   git commit -m "Commit message"

3. Push your branch:

   git push --set-upstream origin <branchname>

4. Create a Pull Request on GitHub. Provide a clear title and description, select reviewers, and open a Draft PR if work is in progress.

ℹ️	Technical changes require SME review. All changes require documentation team review.

Review Standards

• Mark incomplete work with [WIP] in the PR title.

• Do not merge another author’s PR without explicit permission.

• Approvals required:

  • One SME for technical changes.

  • One documentation team member for all changes.

Second Contribution

Keep your fork or local copy synchronized to avoid conflicts. Always update master before new work.

Using a Fork

1. Check out your fork’s master branch.

2. Fetch from upstream and merge into master.

3. Continue work on existing feature branches or create new ones.

With Write Access

1. Check out the master branch.

2. Fetch all branches and update:

   git fetch --all
   git pull -ff

3. Create new branches for new work.

4. Commit early, push often, and use Draft PRs.

Changelog Entries

Update CHANGELOG.md with your changes. Add new entries at the top, separated by dashed lines:

-----------------------------------------------------------------------
- Updated Foo chapter in Installation and Upgrade Guide
- Documented Bar feature in Administration Guide
- Fixed error in Bat section of Upgrade Guide (bsc#1234567)
-----------------------------------------------------------------------

Guidelines: https://en.opensuse.org/openSUSE:Creating_a_changes_file_(RPM)

The Uyuni Documentation Team

• Joseph Cayouette @jcayouette

• Ornela Marić @0rnela