conform to MD022

norwoodj · Nov 29, 2023 · 75774f5 · 75774f5
1 parent 60d02b1
commit 75774f5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/example-charts/sections/README.md b/example-charts/sections/README.md
@@ -1,24 +1,27 @@
 # Sections
 
-This creates values, but sectioned into own section tables if a seciton comment is provided.
+This creates values, but sectioned into own section tables if a section comment is provided.
 
 ## Values
 
 ### Some Section
+
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
 | controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. |
 | controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
 
 ### Special Attention
+
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | controller.ingressClass | string | `"nginx"` | You can also specify value comments like this |
 | controller.publishService | object | `{"enabled":false}` | This is a publishService |
 | controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
 
 ### Other Values
+
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | controller.extraVolumes[0].name | string | `"config-volume"` |  |

diff --git a/pkg/document/template.go b/pkg/document/template.go
@@ -212,6 +212,7 @@ func getValuesTableTemplates() string {
 	valuesSectionBuilder.WriteString("{{ range .Sections.Sections }}")
 	valuesSectionBuilder.WriteString("\n")
 	valuesSectionBuilder.WriteString("\n### {{ .SectionName }}\n")
+	valuesSectionBuilder.WriteString("\n")
 	valuesSectionBuilder.WriteString("| Key | Type | Default | Description |\n")
 	valuesSectionBuilder.WriteString("|-----|------|---------|-------------|\n")
 	valuesSectionBuilder.WriteString("  {{- range .SectionItems }}")
@@ -221,6 +222,7 @@ func getValuesTableTemplates() string {
 	valuesSectionBuilder.WriteString("{{ if .Sections.DefaultSection.SectionItems}}")
 	valuesSectionBuilder.WriteString("\n")
 	valuesSectionBuilder.WriteString("\n### {{ .Sections.DefaultSection.SectionName }}\n")
+	valuesSectionBuilder.WriteString("\n")
 	valuesSectionBuilder.WriteString("| Key | Type | Default | Description |\n")
 	valuesSectionBuilder.WriteString("|-----|------|---------|-------------|\n")
 	valuesSectionBuilder.WriteString("  {{- range .Sections.DefaultSection.SectionItems }}")