From 83a84ad9e14dba8ee77387d5f871319fb03aa510 Mon Sep 17 00:00:00 2001 From: Rita Zhang Date: Mon, 19 Sep 2022 18:02:00 -0700 Subject: [PATCH] docs: Update contributing guide Signed-off-by: Rita Zhang --- website/docs/help.md | 2 +- website/versioned_docs/version-v3.6.x/help.md | 2 +- website/versioned_docs/version-v3.7.x/help.md | 2 +- website/versioned_docs/version-v3.9.x/help.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/help.md b/website/docs/help.md index 74061d01c23..019a1b8f4d3 100644 --- a/website/docs/help.md +++ b/website/docs/help.md @@ -69,7 +69,7 @@ If you want to contribute to docs, Gatekeeper auto-generates versioned docs. If ## Contributing to Helm Chart -If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests`. Your changes will show up in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory and will be promoted to the root charts directory the next time a Gatekeeper release is cut. +If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests` to generate changes in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory. You should push all the modified files to your PR. Once it's merged, the changes will be promoted to the root charts directory the next time a Gatekeeper release is cut. ## Contributing to Code diff --git a/website/versioned_docs/version-v3.6.x/help.md b/website/versioned_docs/version-v3.6.x/help.md index 3b71fd56cdf..00aae9a7064 100644 --- a/website/versioned_docs/version-v3.6.x/help.md +++ b/website/versioned_docs/version-v3.6.x/help.md @@ -69,4 +69,4 @@ If you want to contribute to docs, Gatekeeper auto-generates versioned docs. If ## Contributing to Helm Chart -If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests`. Your changes will show up in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory and will be promoted to the root charts directory the next time a Gatekeeper release is cut. +If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests` to generate changes in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory. You should push all the modified files to your PR. Once it's merged, the changes will be promoted to the root charts directory the next time a Gatekeeper release is cut. diff --git a/website/versioned_docs/version-v3.7.x/help.md b/website/versioned_docs/version-v3.7.x/help.md index 74061d01c23..019a1b8f4d3 100644 --- a/website/versioned_docs/version-v3.7.x/help.md +++ b/website/versioned_docs/version-v3.7.x/help.md @@ -69,7 +69,7 @@ If you want to contribute to docs, Gatekeeper auto-generates versioned docs. If ## Contributing to Helm Chart -If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests`. Your changes will show up in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory and will be promoted to the root charts directory the next time a Gatekeeper release is cut. +If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests` to generate changes in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory. You should push all the modified files to your PR. Once it's merged, the changes will be promoted to the root charts directory the next time a Gatekeeper release is cut. ## Contributing to Code diff --git a/website/versioned_docs/version-v3.9.x/help.md b/website/versioned_docs/version-v3.9.x/help.md index 74061d01c23..019a1b8f4d3 100644 --- a/website/versioned_docs/version-v3.9.x/help.md +++ b/website/versioned_docs/version-v3.9.x/help.md @@ -69,7 +69,7 @@ If you want to contribute to docs, Gatekeeper auto-generates versioned docs. If ## Contributing to Helm Chart -If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests`. Your changes will show up in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory and will be promoted to the root charts directory the next time a Gatekeeper release is cut. +If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Helm charts from static manifests. If you have any changes in [charts](https://github.com/open-policy-agent/gatekeeper/tree/master/charts) directory, they will get clobbered when we do a new release. The generator code lives under [cmd/build/helmify](https://github.com/open-policy-agent/gatekeeper/tree/master/cmd/build/helmify). To make modifications to this template, please edit `kustomization.yaml`, `kustomize-for-helm.yaml` and `replacements.go` under that directory and then run `make manifests` to generate changes in the [manifest_staging](https://github.com/open-policy-agent/gatekeeper/tree/master/manifest_staging) directory. You should push all the modified files to your PR. Once it's merged, the changes will be promoted to the root charts directory the next time a Gatekeeper release is cut. ## Contributing to Code