From 15cc3e059d6dda9e64cdfe54c0845261027e3ed0 Mon Sep 17 00:00:00 2001 From: Max Leonard Inden <IndenML@gmail.com> Date: Wed, 1 Aug 2018 10:37:31 +0200 Subject: [PATCH] */README.md: Include 'Contributing' section --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e58fec6b..b653dc29 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ This stack is meant for cluster monitoring, so it is pre-configured to collect m * [Minikube Example](#minikube-example) * [Troubleshooting](#troubleshooting) * [Error retrieving kubelet metrics](#error-retrieving-kubelet-metrics) +* [Contributing](#contributing) ## Prerequisites @@ -391,3 +392,15 @@ config. They default to: memoryPerNode: '30Mi', } ``` + +## Contributing + +All `.yaml` files in the `/manifests` folder are generated via +[Jsonnet](https://jsonnet.org/). Contributing changes will most likely include +the following process: + +1. Make your changes in the respective `*.jsonnet` file. +2. Commit your changes (This is currently necessary due to our vendoring + process. This is likely to change in the future). +3. Generate dependent `*.yaml` files: `make generate-in-docker`. +4. Commit the generated changes. -- GitLab