Container images for building the Uyuni docs
an invention by juliogonzalezgil
Updated 3 months ago. 2 hacker ♥️. 1 follower.

Project Description

The Uyuni doc requires a lot of dependencies installed to be built. Keeping your system on the right versions or reinstalling can be a challenge.

Moreover, we don't build the documentation on the PRs, so we can inspect it, and we don't have it in any place before we prepare releases.

Goal for this Hackweek

  • Create a container image that can build the doc from a set of parameters (git repository, git reference, product)
  • Publish the container to GitHub (at least for now, OBS is not an option, as a lot of gems and npm packages are required) -> to Docker Hub for now
  • Create a github action to build, on demand, the doc and (somehow) publish it -> postponed

Skills

  • Able to write docker files
  • Familiarity with GitHub actions
  • Familiarity with container images on GitHub
  • Familiarity with publishing objects (if possible static website) from PRs, by using GitHub tooling

Resources

Outcome

https://github.com/uyuni-project/uyuni-docs-helper

Looking for hackers with the skills:

uyuni containers github_actions github_page antora susemanager

This project is part of:

Hack Week 22

Activity

  • 4 months ago: juliogonzalezgil added keyword "susemanager" to this project.
  • 4 months ago: j_renner liked this project.
  • 4 months ago: admehmood liked this project.
  • 4 months ago: juliogonzalezgil added keyword "antora" to this project.
  • 4 months ago: juliogonzalezgil started this project.
  • 4 months ago: juliogonzalezgil added keyword "uyuni" to this project.
  • 4 months ago: juliogonzalezgil added keyword "containers" to this project.
  • 4 months ago: juliogonzalezgil added keyword "github_actions" to this project.
  • 4 months ago: juliogonzalezgil added keyword "github_page" to this project.
  • 4 months ago: juliogonzalezgil originated this project.


    • Comments

    • juliogonzalezgil
      4 months ago by juliogonzalezgil | Reply

      WIP at: https://github.com/juliogonzalez/uyuni-docs-container-image

      For now, I focused on publishing the image to the DockerHub, and being able to build the doc from either a local clone or a remote git repository, so I can easily prepare a demo.

      Publishing to GitHub or using this on PRs, will come later.

    • juliogonzalezgil
      4 months ago by juliogonzalezgil | Reply

      While part of the work is pending, it will be handled as part of my work for SUSE Manager.

      The basics are there, and will be presented to the Uyuni Community and the SUSE Manager stakeholders in the next meetings.

    Similar Projects

    Improve OpenSCAP support in Uyuni by admehmood

    [comment]: # (Please use the project descriptio...

    UYUNI - synchronize content between registry servers by RDiasMateus

    [comment]: # (Please use the project descriptio...

    Deploy Uyuni proxy using Elemental and Fleet by cbosdonnat

    Project Description

    Now that Uyuni proxy ...

    Testing and adding GNU/Linux distributions on Uyuni by juliogonzalezgil

    Join the Gitter channel! [https://gitter.im/uy...

    Create tool to analyze supportconfig to spot common SUSE Manager / Uyuni issues by cbosdonnat

    [comment]: # (Please use the project descriptio...

    Image generation AI in container using Radeon GPU by tjyrinki_suse

    [comment]: # (Please use the project descriptio...

    Containerfile / Dockerfile generator library by amanzini

    [comment]: # (Please use the project descriptio...

    Building a CNF solution for Edge environment by lizhang

    Project Description

    Network managemen...

    Containerized git server/client for playground and tutorials by mberti

    [comment]: # (Please use the project descriptio...

    Run sandboxed Firefox with image and sound inside a container by nguyens

    [comment]: # (Please use the project descriptio...

    Expanding e2e tests on Windows self-hosted runners via CI by iguimaraes

    Achievements:

    • Documented all necessary s...

    Uyuni test suite improvements by dgedon

    Project Description

    Uyuni is the upstream...

    Deploy Uyuni proxy using Elemental and Fleet by cbosdonnat

    Project Description

    Now that Uyuni proxy ...

    Improve OpenSCAP support in Uyuni by admehmood

    [comment]: # (Please use the project descriptio...

    Code Coverage of spacewalk-java aka Suma Server after a full TestSuite execution by oscar-barrios

    Project Description

    GitHub Card: http...

    Testing and adding GNU/Linux distributions on Uyuni by juliogonzalezgil

    Join the Gitter channel! [https://gitter.im/uy...