Explore possibilities for referencing examples in README
Open
Nobody has claimed this yet.
ci
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
At one point, I started exploring whether helm-docs templating could give us some niceties around referencing examples / etc.
(NOTE: this does not work)
We should finish exploring possibilities there and see if our ci/ examples could be a useful reference of valid values
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 the referenced _templates.gotmpl section and the existing ci/ examples to understand the attempted helm-docs templating approach. Determine whether valid example values can be referenced from the README, and consider the work complete when the viable approach or limitation is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100