Helm Chart NOTES.txt: Difference between revisions
Jump to navigation
Jump to search
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=External= | |||
* https://helm.sh/docs/developing_charts/#chart-license-readme-and-notes | |||
=Internal= | =Internal= | ||
| Line 5: | Line 9: | ||
=Overview= | =Overview= | ||
An optional plain text file containing usage notes. | An optional plain text file placed in the 'templates' directory, containing usage notes. It can be thought of as the "help text" for the chart. The content of this file will be printed at stdout by [[helm install]] after installation, and when viewing the status of the release with [[helm status]]. The file is evaluated as a [[Helm_Concepts#Template|template]], and can be used to display usage notes, next steps, etc. | ||
<font color=darkgray>TODO: [https://helm.sh/docs/chart_template_guide/#creating-a-notes-txt-file Creating a NOTES.txt File] | |||
Latest revision as of 05:18, 29 August 2019
External
Internal
Overview
An optional plain text file placed in the 'templates' directory, containing usage notes. It can be thought of as the "help text" for the chart. The content of this file will be printed at stdout by helm install after installation, and when viewing the status of the release with helm status. The file is evaluated as a template, and can be used to display usage notes, next steps, etc.