There are no docs for how to incorporate Ignition in a distro
Open
Nobody has claimed this yet.
area/developer tooling
kind/documentation
- Dominant language
- Go
- Stars
- 974
- Forks
- 296
- Avg merge
- 6d 14h
- Merged PRs (30d)
- 9
Description
Bug
Operating System Version
Any
Ignition Version
Any
Environment
Any
Expected Behavior
Requirements for Ignition to run in the initramfs are documented
Actual Behavior
There are no docs outlining how to include Ignition in the initramfs.
Reproduction Steps
- Be a distro maintainer
- See this snazzy thing called Ignition
- Be lost at what needs to happen to include it in the initramfs
Other Information
cc @thkukuk since they might have some insight on what things would be helpful in that kind of document.
Contributor guide
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
Start by reviewing Ignition's existing documentation and the requirements for including Ignition in a distro's initramfs. Define the initramfs integration steps and prerequisites that distro maintainers need, then document them in an appropriate location. Done means a distro maintainer can follow the documentation without having to infer the requirements.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100