*: docs revamp

CHANGELOG.md

@@ -1,5 +1,8 @@
+# DEPRECATION NOTICE
+
+This file is no longer used. All changes are tracked in each separate chart and also available on GitHub releases page.
+
 # Changelog
-All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

CONTRIBUTING.md

@@ -1,20 +1,45 @@
-# Contributing to TimescaleDB Kubernetes
+# Contributing to Timescale Helm Charts
 
-We appreciate any help the community can provide to make TimescaleDB better!
+We'd love your help!
 
-You can help in different ways:
+## How to Contribute
 
-* Open an [issue](https://github.com/timescale/timescaledb-kubernetes/issues) with a
-  bug report, build issue, feature request, suggestion, etc.
+1. Fork this repository
+1. Develop, and test your changes
+1. Submit a pull request
 
-* Fork this repository and submit a pull request
+_NOTE_: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.
 
-For any particular improvement you want to make, it can be beneficial to
-begin discussion on the GitHub issues page. This is the best place to
-discuss your proposed improvement (and its implementation) with the core
-development team.
+Remember to always work in a branch of your local copy, as you might otherwise
+have to contend with conflicts in master.
 
-Before we accept any code contributions, Timescale contributors need to
-sign the [Contributor License Agreement](https://cla-assistant.io/timescale/timescaledb-kubernetes) (CLA). By signing a CLA, we can
-ensure that the community is free and confident in its ability to use your
-contributions.
+Please also see [GitHub
+flow](https://docs.github.com/en/get-started/quickstart/github-flow).
+
+### Technical Requirements
+
+* Must pass [CLA check](https://cla-assistant.io/timescale/helm-charts)
+* Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/)
+* Must pass CI jobs for linting and installing changed charts with the
+  [chart-testing](https://github.com/helm/chart-testing) tool
+* Any change to a chart requires a version bump following
+  [semver](https://semver.org/) principles. See [Immutability](#immutability)
+  and [Versioning](#versioning) below
+
+Once changes have been merged, the release job will automatically run to package
+and release changed charts.
+
+### Immutability
+
+Chart releases must be immutable. Any change to a chart warrants a chart version
+bump even if it is only changed to the documentation.
+
+### Versioning
+
+The chart `version` should follow [semver](https://semver.org/).
+
+Charts should start at `0.1.0` or `1.0.0`. Any breaking (backwards incompatible)
+changes to a chart should:
+
+1. Bump the MAJOR version
+2. In the README or appropriate document, describe the manual steps necessary to upgrade to the new (specified) MAJOR version

README.md

@@ -1,4 +1,3 @@
-[![Security Audit](https://github.com/timescale/helm-charts/actions/workflows/sec-audit.yml/badge.svg)](https://github.com/timescale/helm-charts/actions/workflows/sec-audit.yml)
 [![Test Helm Charts](https://github.com/timescale/helm-charts/actions/workflows/tests.yml/badge.svg)](https://github.com/timescale/helm-charts/actions/workflows/tests.yml)
 [![Commit activity](https://img.shields.io/github/commit-activity/m/timescale/helm-charts)](https://github.com/timescale/helm-charts/pulse/monthly)
 [![License](https://img.shields.io/github/license/timescale/helm-charts)](https://github.com/timescale/helm-charts/blob/main/LICENSE)
@@ -10,26 +9,27 @@ This repository contains Helm charts to help with the deployment of
 [TimescaleDB](https://github.com/timescale/timescaledb/) and [Promscale](https://github.com/timescale/promscale) on Kubernetes. This
 project is currently in active development.
 
-# Repository
+## Repository
 
-The Charts are available in a Helm Chart Repository, which is part of this project.
+The Charts are available in a Helm Chart Repository hosted in Amazon S3 bucket.
 The following command will make this repository ready for use:
 ```
-helm repo add timescaledb 'https://raw.githubusercontent.com/timescale/timescaledb-kubernetes/master/charts/repo/'
+helm repo add timescale 'https://charts.timescale.com/'
 ```
 For more information, have a look at the [Using Helm](https://helm.sh/docs/intro/using_helm/#helm-repo-working-with-repositories) documentation.
 
-# Additional documentation
+## Additional documentation
 
 - [Why use TimescaleDB?](https://docs.timescale.com/introduction)
 - [Installing TimescaleDB](https://docs.timescale.com/getting-started/installation)
 - [Migrating data to TimescaleDB](https://docs.timescale.com/getting-started/migrating-data)
 - [Tutorials and sample data](https://docs.timescale.com/tutorials)
+- [Installing Promscale](https://docs.timescale.com/promscale/latest/installation/kubernetes/)
 
-## License
+# License
 
 Resources in this repository are released under the [Apache 2.0 license](LICENSE).
 
-## Contributing
+# Contributing
 
 If you wish to make contributions to this project, please refer to [Contributor Instructions](CONTRIBUTING.md) for more information.