add chart name template to examples

norwoodj · Jun 17, 2020 · 8437377 · 8437377
1 parent 5cfba29
commit 8437377
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/example-charts/custom-template/README.md b/example-charts/custom-template/README.md
@@ -12,6 +12,15 @@ aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in volup
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
 culpa qui officia deserunt mollit anim id est laborum.
 
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ helm repo add foo-bar http://charts.foo-bar.com
+$ helm install my-release foo-bar/custom-template
+```
+
 ## Requirements
 
 | Repository | Name | Version |

diff --git a/example-charts/custom-template/README.md.gotmpl b/example-charts/custom-template/README.md.gotmpl
@@ -11,6 +11,15 @@ aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in volup
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
 culpa qui officia deserunt mollit anim id est laborum.
 
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ helm repo add foo-bar http://charts.foo-bar.com
+$ helm install my-release foo-bar/{{ template "chart.name" . }}
+```
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}
diff --git a/example-charts/full-template/README.md b/example-charts/full-template/README.md
@@ -4,6 +4,10 @@
 
 > **:exclamation: This Helm Chart is deprecated!**
 
+## `chart.name`
+
+full-template
+
 ## `chart.description`
 
 A chart for showing every README-element

diff --git a/example-charts/full-template/README.md.gotmpl b/example-charts/full-template/README.md.gotmpl
@@ -10,6 +10,10 @@
 
 {{ template "chart.deprecationWarning" . }}
 
+## `chart.name`
+
+{{ template "chart.name" . }}
+
 ## `chart.description`
 
 {{ template "chart.description" . }}