From a99aabbd5a55ede47553850210836b119a589354 Mon Sep 17 00:00:00 2001 From: Adam Pickering Date: Thu, 21 Mar 2024 17:01:49 -0600 Subject: [PATCH] Update docs for change to `crdOptions` and `upstreamOptions` behavior (#3672) --- docs/experimental.md | 2 +- docs/packages.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/experimental.md b/docs/experimental.md index 812fe24cd..560187144 100755 --- a/docs/experimental.md +++ b/docs/experimental.md @@ -41,4 +41,4 @@ If you would like to perform local validation only (e.g. checking if `make chart If you would like to perform remote validation only (e.g. checking if all differences between your current repository and an upstream repository are tracked in the `release.yaml`), you can run `./bin/charts-build-scripts validate --upstream`. -Note: These options have **not** been exposed as environment variables since an average consumer of the scripts should rarely, if at all, have any reason for using these options. \ No newline at end of file +Note: These options have **not** been exposed as environment variables since an average consumer of the scripts should rarely, if at all, have any reason for using these options. diff --git a/docs/packages.md b/docs/packages.md index 7cddeab41..dece6033d 100755 --- a/docs/packages.md +++ b/docs/packages.md @@ -22,12 +22,10 @@ additionalCharts: # These contain other charts that you would like to package alongside this chart - workingDir: # same as above upstreamOptions: - # Mutually exclusive with crdOptions url: # same as above subdirectory: # optional, same as above commit: # optional, same as above crdOptions: - # Mutually exclusive with upstreamOptions templateDirectory: # A directory within packages//template that will contain a template for your CRD chart crdDirectory: # Where to place your CRDs within a CRD chart (e.g. crds for default charts) addCRDValidationToMainChart: # Whether to add additional validation to your main chart to check that the CRD chart is installed. @@ -45,7 +43,9 @@ Charts or AdditionalCharts can provide UpstreamOptions with the following possib #### Additional Charts CRD Options -AdditionalCharts can provide CRDOptions instead of UpstreamOptions. These CRDOptions allow the scripts to automatically construct a CRD chart from your main Chart's contents based on the template provided. +AdditionalCharts can provide CRDOptions instead of or in addition to +UpstreamOptions. These CRDOptions allow the scripts to automatically construct a +CRD chart from your main Chart's contents based on the template provided. A CRD Chart is a Helm Chart whose sole purpose is to install CRDs onto a cluster before the main Chart is installed.