Update the rstudio-workbench README.md
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
The current README.md has a section labelled Required Configuration that explains what to do in the event you are NOT having it create homeStorage for you. If you are mounting up a specific PVC, it has a lot of different steps. While working through this, and looking for documentation on the dcf format so I could add a section for config.serverDcf.launcher-mounts I was informed that there is an easier way using new values!
There are a couple of new values that make life easier for mounting up a PVC to workbench and the launcher sessions:
https://github.com/rstudio/helm/blob/c20af532d95c263e3f1d9b3ef008760f21df6b52/charts/rstudio-workbench/values.yaml#L105-L108
These should be explained in the Required Configuration section, rather than the longer and more complicated procedure for setting pod mounts and launcher mounts.
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
Read charts/rstudio-workbench/README.md, especially the Required Configuration section, and compare it with the referenced values in charts/rstudio-workbench/values.yaml. Update the section to explain the simpler PVC and launcher-session configuration, replacing the longer procedure; the README should clearly cover mounting a specific PVC without requiring pod and launcher mount steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100