This website is built using Docusaurus, a modern static website generator.
$ make install-dependencies
$ make run
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ make build
This command generates static content into the build directory and can be served using any static contents hosting service.
When using relative links, please make sure they are path-based, and not URL-based.
❌ Bad:
[Blueprint](../overview/blueprint)✅ Good:
[Blueprint](../01-overview/blueprint.md)This follows Docusaurus' guidance, see their docs for more information.
docs/user-guide/09-image-descriptions/ is generated — do not hand-edit those pages.
make generate # all external content, including image descriptions
make pull-image-descriptions # package-mode distros + bootc only
# bootc-only (no CLI container / describe):
make pull-bootc-image-descriptions
# or:
python3 scripts/pull_image_descriptions.py --bootc-only \
--bootc-imagetypes /path/to/image-builder/data/distrodefs/bootc-generic/imagetypes.yamlFreshness depends on upstream Image Builder being up to date:
| Path | Source |
|---|---|
| Package mode | ghcr.io/osbuild/image-builder-cli:latest via list-images + describe (CONTAINER_IMAGE in scripts/pull_image_descriptions.py). Pull the image before regenerating or docs lag. |
| Image mode (bootc) | data/distrodefs/bootc-generic/imagetypes.yaml in osbuild/image-builder (same project that builds the CLI image; distrodefs are go:embed’d, so not loose files inside the container). Pass --bootc-imagetypes / BOOTC_IMAGETYPES, or the script fetches from main on GitHub. |
CI: .github/workflows/pull.yml does not call make generate by name, but it runs make pull-image-descriptions (after installing podman). That target regenerates package-mode pages and bootc (00-bootc/), then git add . commits any drift — so bootc docs update implicitly on the daily schedule / workflow_dispatch.