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
Looking for hackers with the skills:
uyuni containers github_actions github_page antora susemanager
This project is part of:
Hack Week 22
Activity
Comments
-
about 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.
-
about 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
Deep clean-up of the Uyuni documentation files by omaric
Project Description
This project is plann...
Integration of Ironic in Uyuni for automating provisioning of bare metal machines. by ygutierrez
[comment]: # (Please use the project descriptio...
Testing and adding GNU/Linux distributions on Uyuni by juliogonzalezgil
Join the Gitter channel! [https://gitter.im/uy...
Create language model based on Uyuni documentation by nadvornik
[comment]: # (Please use the project descriptio...
Enhance product migration feature in Uyuni(SUSE Manager) to migrate from regular SLES to SLES4SAP by admehmood
[comment]: # (Please use the project descriptio...
Predefined app security policy template for NeuVector by feih
Project Description
Idea is to predefin...
Package MONAI Machine Learning Models for Medical Applications by jordimassaguerpla
Project Description
MONAI Deploy aims to ...
Forklift - Text based GUI utility for dealing with containers by andreabenini
[comment]: # (Please use the project descriptio...
A set of utilities to produce a "from scratch" OCI/Docker container using Opensuse/SLE rpms by ldragon
[comment]: # (Please use the project descriptio...
Exploring DPDK within containers by paolodepa
Project Description
Containerization is h...
Package MONAI Machine Learning Models for Medical Applications by jordimassaguerpla
Project Description
MONAI Deploy aims to ...
Collect flaky test cases identified by the team in a GitHub board and highlight them in the Test report by oscar-barrios
Project Description
Flaky tests: Th...
Enhance product migration feature in Uyuni(SUSE Manager) to migrate from regular SLES to SLES4SAP by admehmood
[comment]: # (Please use the project descriptio...
Testing and adding GNU/Linux distributions on Uyuni by juliogonzalezgil
Join the Gitter channel! [https://gitter.im/uy...
Generate ignition/combustion files from Uyuni/SUSE Manager by dvosburg
[comment]: # (Please use the project descriptio...
Integration of Ironic in Uyuni for automating provisioning of bare metal machines. by ygutierrez
[comment]: # (Please use the project descriptio...