github.com/strongmonkey/helm@v2.7.2+incompatible/docs/chart_template_guide/notes_files.md (about)

     1  # Creating a NOTES.txt File
     2  
     3  In this section we are going to look at Helm's tool for providing instructions to your chart users. At the end of a `chart install` or `chart upgrade`, Helm can print out a block of helpful information for users. This information is highly customizable using templates.
     4  
     5  To add installation notes to your chart, simply create a `templates/NOTES.txt` file. This file is plain text, but it is processed like as a template, and has all the normal template functions and objects available.
     6  
     7  Let's create a simple `NOTES.txt` file:
     8  
     9  ```
    10  Thank you for installing {{ .Chart.Name }}.
    11  
    12  Your release is named {{ .Release.Name }}.
    13  
    14  To learn more about the release, try:
    15  
    16    $ helm status {{ .Release.Name }}
    17    $ helm get {{ .Release.Name }}
    18  
    19  ```
    20  
    21  Now if we run `helm install ./mychart` we will see this message at the bottom:
    22  
    23  ```
    24  RESOURCES:
    25  ==> v1/Secret
    26  NAME                   TYPE      DATA      AGE
    27  rude-cardinal-secret   Opaque    1         0s
    28  
    29  ==> v1/ConfigMap
    30  NAME                      DATA      AGE
    31  rude-cardinal-configmap   3         0s
    32  
    33  
    34  NOTES:
    35  Thank you for installing mychart.
    36  
    37  Your release is named rude-cardinal.
    38  
    39  To learn more about the release, try:
    40  
    41    $ helm status rude-cardinal
    42    $ helm get rude-cardinal
    43  ```
    44  
    45  Using `NOTES.txt` this way is a great way to give your users detailed information about how to use their newly installed chart. Creating a `NOTES.txt` file is strongly recommended, though it is not required.