improve docs

sourcegraph · Jun 17, 2020 · 2f60a4d · 2f60a4d
1 parent 2981a3d
commit 2f60a4d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docker-images/grafana/cmd/grafana-wrapper/grafana.go b/docker-images/grafana/cmd/grafana-wrapper/grafana.go
@@ -156,6 +156,8 @@ func getGrafanaConfig() (*ini.File, error) {
 	if err != nil {
 		return nil, fmt.Errorf("failed to load Grafana config: %w", err)
 	}
+	// set pattern to automatically convert struct fields to Grafana's INI casing
+	// see https://grafana.com/docs/grafana/latest/installation/configuration
 	grafanaConfig.NameMapper = ini.TitleUnderscore
 	return grafanaConfig, nil
 }
diff --git a/docker-images/grafana/cmd/grafana-wrapper/smtp.go b/docker-images/grafana/cmd/grafana-wrapper/smtp.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 )
 
+// grafanaConfigSMTP describes Grafana's SMTP configuration - https://grafana.com/docs/grafana/latest/installation/configuration/#smtp
 type grafanaConfigSMTP struct {
 	Enabled      bool
 	Host         string