Rough-draft upgrade settings documentation [#8]

2019-12-20 16:07:05 -08:00
parent cab3a8ae95
commit 3eb90651d1
3 changed files with 90 additions and 0 deletions
--- a/internal/run/upgrade.go
+++ b/internal/run/upgrade.go
@@ -25,6 +25,8 @@ func (u *Upgrade) Execute(_ Config) error {
 }

 // Prepare gets the Upgrade ready to execute.
+// Note: mandatory settings are documented in README.md, and the full list of settings is in docs/upgrade_settings.yml.
+// Any additions or deletions here should be reflected there.
 func (u *Upgrade) Prepare(cfg Config) error {
 	if u.Chart == "" {
 		return fmt.Errorf("chart is required")