{"id":20078388,"url":"https://github.com/uyuni-project/uyuni-docs-helper","last_synced_at":"2025-07-25T21:31:35.545Z","repository":{"id":65843033,"uuid":"596980914","full_name":"uyuni-project/uyuni-docs-helper","owner":"uyuni-project","description":"A container image and a helper to build the Uyuni documentation without worrying about the toolchain","archived":false,"fork":false,"pushed_at":"2024-08-22T11:28:09.000Z","size":53,"stargazers_count":1,"open_issues_count":2,"forks_count":4,"subscribers_count":24,"default_branch":"main","last_synced_at":"2024-08-22T12:58:08.188Z","etag":null,"topics":["antora","docker","documentation","podman","susemanager","uyuni"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uyuni-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-03T11:05:57.000Z","updated_at":"2024-08-22T11:28:05.000Z","dependencies_parsed_at":"2023-11-25T11:27:17.707Z","dependency_job_id":"9201512e-aa06-4b5c-a9f7-d54a2d5e7ee1","html_url":"https://github.com/uyuni-project/uyuni-docs-helper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uyuni-project%2Fuyuni-docs-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uyuni-project%2Fuyuni-docs-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uyuni-project%2Fuyuni-docs-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uyuni-project%2Fuyuni-docs-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uyuni-project","download_url":"https://codeload.github.com/uyuni-project/uyuni-docs-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224470918,"owners_count":17316710,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antora","docker","documentation","podman","susemanager","uyuni"],"created_at":"2024-11-13T15:14:14.423Z","updated_at":"2025-05-05T22:32:24.241Z","avatar_url":"https://github.com/uyuni-project.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Repository purpose\n\nTo provide a way of building a container image to build the [Uyuni documentation](https://github.com/uyuni-project/uyuni-docs), as it requires to install a big set of tools using `zypper`, `nvm`, `cpan`, `gem` etc.\n\nBesides the container, a helper is provider so people that does not know anything about containers can easily use them.\n\nThis a result of [SUSE's Hack Week 22](https://hackweek.opensuse.org/22/projects/testing-gnu-slash-linux-distributions-on-uyuni)\n\n# Repository structure\n\n## For everyone\n- `uyuni-docs-helper`: The bash script that allows any contributor to build, inspect the outputs of the build procedure via HTTP and even get outputs at the local system.\n\n### Example\n\n`./uyuni-docs-helper -r master -o /tmp/test -c obs-packages-mlm-en -p mlm` would build the HTML and PDFs for English language, from the `master` branch at https://github.com/uyuni-project/uyuni-docs (default repository), for SUSE Multi-Linux Manager.\n\n## For image maintainers\n\n- `image` directory: Contains the Dockerfile, the `startup.sh` script for the container, and the `build-locally` helper (that can be used to build the container locally for testing, passing arguments to the build, such as `--no-cache` is allowed). See below for more details\n- `.github/workflows`: Contains the `build-and-publish-container-images.yml` workflow definition to build and publish the image to the GitHub Container registry after each change on the repository\n\n# Requirements\n\n## For everyone\n\n- Have `podman` installed (recommended)\n\nor\n\n- Have `docker` installed and an alias `podman` that calls `docker` (for bash that means adding `alias docker='podman'` to the file `~/.alias`)\n\n## macOS users\n\nInstall the package `gnu-getopt` via e.g. Homebrew (https://brew.sh):\n\n```bash\nbrew install gnu-getopt\n```\n\nGet Podman ready\n\n```bash\npodman machine init\npodman machine start\n# verify the connection\npodman system connection list\n```\n\n## For image maintainers\n\nThe image is built and published automatically to `ghcr.io/\u003cPROJECT\u003e/uyuni-docs-helper:\u003cBRANCH\u003e` after each push to any repository branch.\n\nBy default:\n- `\u003cPROJECT\u003e` will be `uyuni-project`, unless you are working with your fork\n- `\u003cBRANCH\u003e` will be the branch name that got the push, it's the tag for the container image\n\nYou can also build the image locally with the script at `images/build-locally`. In that case the image will be generated as `local/uyuni-docs-helper:latest` (notice `local` is here the project).\n\nYou can then use `uyuni-docs-helper` with the `-j` and `-t` parameters to specify the right tag and project.\n\n# Troubleshooting\n\nSee [TROUBLESHOOTING.md](TROUBLESHOOTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuyuni-project%2Fuyuni-docs-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuyuni-project%2Fuyuni-docs-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuyuni-project%2Fuyuni-docs-helper/lists"}