Container images for building the Uyuni docs
an invention by juliogonzalezgil
Updated over 1 year 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

  • https://github.com/uyuni-project/uyuni-docs
  • https://github.com/uyuni-project/uyuni-docs/wiki/Install-the-latest-documentation-toolchain
  • https://github.com/jordimassaguerpla/uyuni/blob/master/.github/workflows/build_containers.yml
  • https://github.com/jordimassaguerpla/uyuni/actions/runs/4024484061/workflow

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

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


    • Comments

    • juliogonzalezgil
      over 1 year 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
      over 1 year 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

    This project is one of its kind!