From e750dbdbe6f9f9c0721e5ebf197986f951c7b4a7 Mon Sep 17 00:00:00 2001 From: Chris Campo Date: Tue, 30 Jul 2024 15:20:29 -0400 Subject: [PATCH] Add dev README --- README_dev.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README_dev.md diff --git a/README_dev.md b/README_dev.md new file mode 100644 index 0000000..3f2d667 --- /dev/null +++ b/README_dev.md @@ -0,0 +1,17 @@ +# Development + +This document contains information about the development process for this +repository. + +## README Generation + +The [README](README.md) contains some auto-generated content related to Helm +values. Specifically, content related to any specific Helm value should be added +as comments to [`values.yaml`](values.yaml), and they will be added to the +README via a [pre-commit](https://pre-commit.com/) job. + +To generate the README, run the following command: + +```shell +pre-commit run --all-files +```