From 094b97ab5d7e2f6eda6d0ab0f2ede9cf578c003c Mon Sep 17 00:00:00 2001 From: Anton Osmond Date: Fri, 7 Sep 2018 21:41:40 +0100 Subject: [PATCH] Be explicit about where occurences of will be replaced in starter charts (#4548) Signed-off-by: Anton Osmond --- docs/charts.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/charts.md b/docs/charts.md index 0414136ce..37e7fe038 100644 --- a/docs/charts.md +++ b/docs/charts.md @@ -848,8 +848,10 @@ considerations in mind: - The `Chart.yaml` will be overwritten by the generator. - Users will expect to modify such a chart's contents, so documentation should indicate how users can do so. -- All occurrences of `` will be replaced with the specified chart - name so that starter charts can be used as templates. +- All occurrences of `` in files within the `templates` directory + will be replaced with the specified chart name so that starter charts can be + used as templates. Additionally, occurrences of `` in + `values.yaml` will also be replaced. Currently the only way to add a chart to `$HELM_HOME/starters` is to manually copy it there. In your chart's documentation, you may want to explain that