Add public-facing readmes #1
Conversation
There are at present quite a few unpublic patterns used to get the rstudio-workbench chart working in production environments that have never been documented, so this adds some of that documentation here so our chart users can understand what needs to be done to be successful.
| We have a few outlets for getting support with our projects: | ||
|
|
||
| - Bugs or feature requests should be opened in an [issue](https://github.com/rstudio/helm/issues/new/choose). | ||
| - Professional support for our Helm charts can be obtained by emailing support@rstudio.com. Please note that email support is limited to our professional products customers. |
There was a problem hiding this comment.
@bdeitte do we have preferred wording here? Should we highlight that "Professional support for our products" is what is supported (versus the helm charts)? I know you did a bunch of work w/ the wording on support for the containers
There was a problem hiding this comment.
Yeah I think we should use similar wording to what we have in docker, since that was run by Amanda/etc. At least until we've done more here. Something similar to https://github.com/rstudio/rstudio-docker-products#rstudio-pro-products-docker-images
Co-authored-by: Cole Arendt <cole@rstudio.com>
There was a problem hiding this comment.
As @colearendt mentioned, the README for RSW comes from a template. Maybe you should remove that file from this repo and open a PR for that template in rstudio/sol-eng-helm instead? Then we can copy that over when we port the RSW chart to this repo.
|
@jonyoder I wanted this to be a complete doc focused PR, so I went ahead and added the necessary template files into this PR. When we copy over the rest of the repo, we can leave those out. |
|
|
|
@colearendt Everything should be addressed and ready for re-review aside from the open question to @bdeitte |
|
Oh @kfeinauer I think we need to bump the RSPM chart version ( |
Associated with https://github.com/rstudio/sol-eng-helm/issues/64.
This is a first attempt at the main README and the
rstudio-workbenchREADME. Followup PRs will be done for the other charts.