From 75774f5b677c3763b3fa99da5f825137bf79e7c7 Mon Sep 17 00:00:00 2001 From: Haepaxlog Date: Wed, 29 Nov 2023 08:23:15 +0100 Subject: [PATCH] conform to MD022 --- example-charts/sections/README.md | 5 ++++- pkg/document/template.go | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/example-charts/sections/README.md b/example-charts/sections/README.md index 1efadfc..020843a 100644 --- a/example-charts/sections/README.md +++ b/example-charts/sections/README.md @@ -1,10 +1,11 @@ # 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 | @@ -12,6 +13,7 @@ This creates values, but sectioned into own section tables if a seciton comment | 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 | @@ -19,6 +21,7 @@ This creates values, but sectioned into own section tables if a seciton comment | 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 index ae268e5..88f5e60 100644 --- 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 }}")