Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hardware Documentation - customising hardware spec #333

Closed
thebsdbox opened this issue Oct 9, 2020 · 1 comment
Closed

Hardware Documentation - customising hardware spec #333

thebsdbox opened this issue Oct 9, 2020 · 1 comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. needs-docs This label notifies the author of a PR that documentation is needed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/S estimate of the amount of work to address the issue

Comments

@thebsdbox
Copy link
Contributor

Expected Behaviour

Documentation that details:

  • Modifying hardware JSON spec to pass additional kernel flags
  • Passing a custom kernel or initrd
  • What is the usage of various parts of the JSON specification

Current Behaviour

We currently have minimal documentation around the hardware specification and what it all means to an end user.

Possible Solution

Context

The current documentation shows a hardware specification but doesn't detail what a lot of it means, resulting in confused end-users when creating or debugging errors.
@thebsdbox thebsdbox added kind/documentation Categorizes issue or PR as related to documentation. size/S estimate of the amount of work to address the issue priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. needs-docs This label notifies the author of a PR that documentation is needed labels Oct 9, 2020
@tstromberg tstromberg added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Aug 27, 2021
@jacobweinstock jacobweinstock added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Feb 8, 2022
@chrisdoherty4 chrisdoherty4 mentioned this issue Dec 27, 2022
Open
@chrisdoherty4
Copy link
Member

See the ongoing documentation effort for more information tinkerbell/roadmap#5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. needs-docs This label notifies the author of a PR that documentation is needed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/S estimate of the amount of work to address the issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@tstromberg @thebsdbox @chrisdoherty4 @jacobweinstock