fix docs

README.md

@@ -6,24 +6,3 @@ A repo holding the Kubernetes deployment manifests for the governor ecosystem
 
 [Governor API](https://github.com/metal-toolbox/governor-api)
 
-## Installation
-
-* Add the Equinix Metal helm repository
-
-```bash
-helm repo add equinixmetal https://helm.equinixmetal.com
-```
-
-* Install the helm chart using default values
-
-```bash
-helm install governor-api equinixmetal/governor-api
-```
-
-> If you are using your own chart, reference the following to your chart's dependencies:
-> ```yaml
-> dependencies:
->   - name: governor-api
->     version: v0.0.1
->     repository: "https://helm.equinixmetal.com"
-> ```

governor-api/README.md

@@ -1,15 +1,36 @@
-# governor-api
+# Governor
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.0.1](https://img.shields.io/badge/AppVersion-v0.0.1-informational?style=flat-square)
+This is a helm chart that deploys a [Krakend](https://www.krakend.io/) instance.
 
-A helm chart for Governor-API
+## Description
 
-## Requirements
+A repo holding the Kubernetes deployment manifests for the governor ecosystem
 
-| Repository | Name | Version |
-|------------|------|---------|
-| https://charts.bitnami.com/bitnami | common | 2.4.0 |
-| https://helm.equinixmetal.com | k8s-otel-collector | 0.6.1 |
+[Governor API](https://github.com/metal-toolbox/governor-api)
+
+## Installation
+
+* Add the Equinix Metal helm repository
+
+```bash
+helm repo add equinixmetal https://helm.equinixmetal.com
+```
+
+* Install the helm chart using default values
+
+```bash
+helm install governor-api equinixmetal/governor-api
+```
+
+> If you are using your own chart, reference the following to your chart's dependencies:
+> ```yaml
+> dependencies:
+>   - name: governor-api
+>     version: v0.0.1
+>     repository: "https://helm.equinixmetal.com"
+> ```
+
+## Usage
 
 ## Values
 
@@ -70,5 +91,37 @@ A helm chart for Governor-API
 | tracing.secrets.enabled | bool | `false` |  |
 | tracing.secrets.honeycombKey | string | `nil` |  |
 
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+## Development
+
+### Prerequisites
+
+- [helm](https://helm.sh/docs/intro/install/)
+- [helm-docs](https://github.com/norwoodj/helm-docs)
+
+### Testing
+
+Ensure that the documentation is up to date before pushing a pull request:
+
+```bash
+helm-docs
+```
+
+### Releasing
+
+There is a useful Makefile target that's useful to cut a release. So, simply do:
+
+```bash
+TAG=$RELEASE_VERSION make release
+```
+
+And the release will happen.
+
+Note that this project follows the [Semantic Versioning scheme](https://semver.org/), so
+make sure to follow it when cutting releases.
+
+The `TAG` Makefile variable takes a release version without the `v` prefix. For example,
+if you want to cut a release with version `v1.2.3`, you'd do:
+
+```bash
+TAG=1.2.3 make release
+```