Merge pull request #1 from rstudio/public-readmes

Add public-facing readmes

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+## Filing Bugs
+
+If you're experiencing behavior that appears to be a bug in any of the Helm charts, you're welcome to [file an issue](https://github.com/rstudio/helm/issues/new). 
+
+## Enhancements
+
+You're also welcome to submit ideas for enhancements to our Helm charts. When doing so, please [search the issue list](https://github.com/rstudio/helm/issues) to see if the enhancement has already been filed. If it has, vote for it (add a reaction to it) and optionally add a comment with your perspective on the idea. 
+
+## Contributing Code
+
+We welcome contributions to our Helm charts! Before submitting your contribution, we ask that you ensure the change is helpful in a generic sense and is not tied to any specific organizational use-cases that would not be valuable to other organizations.
+
+To submit a contribution:
+
+1. [Fork](https://github.com/rstudio/helm/fork) the repository and make your changes.
+
+2. Submit a [pull request](https://help.github.com/articles/using-pull-requests).
+
+3. Sign the Contributor License Agreement via GitHub. A comment will be added to your pull request indicating if you need to sign the agreement and the link to do so.
+
+We'll try to be as responsive as possible in reviewing and accepting pull requests. We highly appreciate your contributions!
+
+## Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at <https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html>.

README.md

@@ -1,4 +1,32 @@
-# helm
-Helm Resources for RStudio Products
+# RStudio Helm charts
 
-This repository will eventually be made public, and it will contain public Helm charts for our products.
+## Usage
+
+1. Install [Helm](https://helm.sh). Please refer to Helm's [documentation](https://helm.sh/docs/) for more information on getting started.
+
+2. Add the RStudio Helm repo:
+
+   ```console
+   helm repo add rstudio https://helm.rstudio.com
+   ```
+
+3. View charts:
+
+   ```console
+   helm search repo rstudio
+   ```
+
+## Support
+
+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 [email protected]. Please note that email support is limited to our professional products customers.
+
+## Contributing
+
+RStudio values your contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
+
+## License
+
+[MIT License](./LICENSE)

charts/_templates.gotmpl

@@ -2,7 +2,7 @@
 
 ## Disclaimer
 
-> This chart is "alpha" or "beta" quality at best. It is used primarily internally, is under-tested, and will undergo
+> This chart is "beta" quality. It will likely undergo
 > breaking changes without warning as it moves towards stability.
 
 As a result, please:

charts/rstudio-pm/Chart.yaml

@@ -1,6 +1,6 @@
 name: rstudio-pm
 description: Kubernetes deployment for RStudio Package Manager
-version: 0.2.0-rc01
+version: 0.2.0-rc02
 apiVersion: v2
 appVersion: 1.2.2.1-17
 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png

charts/rstudio-pm/README.md

@@ -2,11 +2,11 @@
 
 Kubernetes deployment for RStudio Package Manager
 
-![Version: 0.2.0-rc01](https://img.shields.io/badge/Version-0.2.0--rc01-informational?style=flat-square) ![AppVersion: 1.2.2.1-17](https://img.shields.io/badge/AppVersion-1.2.2.1--17-informational?style=flat-square)
+![Version: 0.2.0-rc02](https://img.shields.io/badge/Version-0.2.0--rc02-informational?style=flat-square) ![AppVersion: 1.2.2.1-17](https://img.shields.io/badge/AppVersion-1.2.2.1--17-informational?style=flat-square)
 
 ## Disclaimer
 
-> This chart is "alpha" or "beta" quality at best. It is used primarily internally, is under-tested, and will undergo
+> This chart is "beta" quality. It will likely undergo
 > breaking changes without warning as it moves towards stability.
 
 As a result, please:
@@ -20,11 +20,11 @@ changes, as well as documentation below on how to use the chart
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release` at version 0.2.0-rc01:
+To install the chart with the release name `my-release` at version 0.2.0-rc02:
 
 ```bash
 helm repo add rstudio-helm https://helm.rstudio.com
-helm install my-release rstudio-helm/rstudio-pm --version=0.2.0-rc01
+helm install my-release rstudio-helm/rstudio-pm --version=0.2.0-rc02
 ```
 
 ## General Principles