Add /docs readme for updating and contributing to the Helm docs
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
It isn't clear what files actually "do the editing" for the Helm docs.
Probably should add to the readme that to edit the docs for Workbench, Connect, PPM, and Chronicle Overview pages, it requires a combo update of the following:
- /helm/charts/_templates.gotmpl
- charts/posit-chronicle/README.md.gotmpl
- charts/rstudio-connect/README.md.gotmpl
- charts/rstudio-pm/README.md.gotmpl
- charts/rstudio-workbench/README.md.gotmpl
And to preview changes:
quarto preview --render html
In addition, we should also add how to edit the Examples doc for each product as well.
### Tasks
- [ ] It also wasn't clear that I needed to install `helm-docs` and run `just setup`
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 locating the /docs README and reviewing the listed Helm documentation templates, including /helm/charts/_templates.gotmpl and the product README.md.gotmpl files. Check the existing setup guidance for helm-docs, just setup, and quarto preview --render html, then document how to update the product and Examples pages. Done means a newcomer can identify the files, prerequisites, preview command, and contribution workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100