osbuild / osbuild/osbuild.github.io
Documentation inconsistencies for usage/reference
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 22
- Avg merge
- 34m
- Merged PRs (30d)
- 2
Description
Playing with osbuild locally, I ran into 2 issues with the online documentation to run builds locally when using Fedora 39 as the OS I was developing my image(s) on:
-
The
composer-clipackage is actuallyweldr-clientfordnfoperations in current versions of Fedora. Referencing: https://osbuild.org/docs/on-premises/installation/ -
When I attempt to do a
filescustomization install into/root(well aware of the cautions, was just trying some ideas out) - my composition didn't seem to accept that as a possible path. Referencing: https://osbuild.org/docs/user-guide/blueprint-reference (Files and directories section). I wasn't sure if I was hitting a change/limitation or maybe just using the wrong pathing (maybe I should've tried/var/roothome).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the on-premises installation page and its package instructions, then check the Blueprint Reference's Files and directories section. Verify the Fedora 39 package name and whether installing files into /root is supported; update both documentation areas to state the correct package and path behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fedora
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100