Skip to content

Commit

Permalink
Fixed dead links and linting
Browse files Browse the repository at this point in the history
  • Loading branch information
Jürgen Kirschbaum committed Feb 9, 2023
1 parent 4b15096 commit 2130994
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,26 @@ The APPUiO Charts project accepts contributions via GitHub pull requests. This d
* Must include source GitHub repositories for images used in the Chart
* Images should not have any major security vulnerabilities
* Must be up-to-date with the latest stable Helm/Kubernetes features
* Use Deployments in favor of ReplicationControllers
* Use Deployments in favor of ReplicationControllers
* Should follow Kubernetes best practices
* Include Health Checks wherever practical
* Allow configurable [resource requests and limits](http://kubernetes.io/docs/user-guide/compute-resources/#resource-requests-and-limits-of-pod-and-container)
* Include Health Checks wherever practical
* Allow configurable [resource requests and limits](http://kubernetes.io/docs/user-guide/compute-resources/#resource-requests-and-limits-of-pod-and-container)
* Provide a method for data persistence (if applicable)
* Support application upgrades
* Allow customization of the application configuration
* Provide a secure default configuration
* Do not leverage alpha features of Kubernetes
* Includes a [NOTES.txt](https://github.com/helm/helm/blob/master/docs/charts.md#chart-license-readme-and-notes) explaining how to use the application after install
* Follows [best practices](https://github.com/helm/helm/tree/master/docs/chart_best_practices)
(especially for [labels](https://github.com/helm/helm/blob/master/docs/chart_best_practices/labels.md)
and [values](https://github.com/helm/helm/blob/master/docs/chart_best_practices/values.md))
* Includes a [NOTES.txt](https://helm.sh/docs/topics/charts/#chart-license-readme-and-notes) explaining how to use the application after install
* Follows [best practices](https://helm.sh/docs/chart_best_practices/)
(especially for [labels](https://helm.sh/docs/chart_best_practices/labels/)
and [values](https://helm.sh/docs/chart_best_practices/values/))

### Documentation requirements

* Must include an in-depth `README.md`, including:
* Short description of the Chart
* Any prerequisites or requirements
* Customization: explaining options in `values.yaml` and their defaults
* Short description of the Chart
* Any prerequisites or requirements
* Customization: explaining options in `values.yaml` and their defaults
* Must include a short `NOTES.txt`, including:
* Any relevant post-installation information for the Chart
* Instructions on how to access the application or service provided by the Chart
* Any relevant post-installation information for the Chart
* Instructions on how to access the application or service provided by the Chart

0 comments on commit 2130994

Please sign in to comment.