redhat-cop / redhat-cop/ocp4-helpernode
"Baremetal" VAR not documented
Open
Nobody has claimed this yet.
documentation
enhancement
good first issue
help wanted
- Dominant language
- Jinja
- Stars
- 358
- Forks
- 308
- PR merge metrics
- No merged PRs in 30d
Description
There is a VAR that is called baremetal: that isn't documented anywhere.
- There should be an explanation of what the var does and doesn't do
- There should be examples of how to use it
- There should be an explanation of WHEN to use it.
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
Locate the baremetal: VAR definition and the existing variable documentation before determining where this option should be documented. Read how the variable is used to establish what it does and does not do, then document its purpose, usage examples, and when to choose it; done means all three points are covered clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100