Change example section chart to new templates

norwoodj · Nov 8, 2023 · 60d02b1 · 60d02b1
1 parent 84eb04f
commit 60d02b1
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 85 deletions.
diff --git a/example-charts/sections/Chart.yaml b/example-charts/sections/Chart.yaml
@@ -1,6 +1,5 @@
 apiVersion: v2
 name: sections
-deprecated: true
 version: "1.0.0"
 type: application
 appVersion: "13.0.0"
@@ -10,10 +9,4 @@ maintainers:
   - email: [email protected]
     name: Constantin Rohde
 sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/sections"]
-kubeVersion: "<=1.18"
-engine: gotpl
-
-dependencies:
-  - name: nginx-ingress
-    version: "0.22.1"
-    repository: "@stable"
+engine: gotpl
diff --git a/example-charts/sections/README.md b/example-charts/sections/README.md
@@ -1,16 +1,8 @@
 # Sections
 
-## Values
+This creates values, but sectioned into own section tables if a seciton comment is provided.
 
-### General
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| controller.extraVolumes[0].name | string | `"config-volume"` |  |
-| controller.image.repository | string | `"nginx-ingress-controller"` |  |
-| controller.image.tag | string | `"18.0831"` |  |
-| controller.name | string | `"controller"` |  |
-| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
-| controller.service.type | string | `"LoadBalancer"` |  |
+## Values
 
 ### Some Section
 | Key | Type | Default | Description |
@@ -26,73 +18,18 @@
 | 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"` |  |
+| controller.image.repository | string | `"nginx-ingress-controller"` |  |
+| controller.image.tag | string | `"18.0831"` |  |
+| controller.name | string | `"controller"` |  |
+| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
+| controller.service.type | string | `"LoadBalancer"` |  |
+
 ## Values
 
-<h3>General</h3>
-<table>
-	<thead>
-		<th>Key</th>
-		<th>Type</th>
-		<th>Default</th>
-		<th>Description</th>
-	</thead>
-	<tbody>
-		<tr>
-			<td>controller.extraVolumes[0].name</td>
-			<td>string</td>
-			<td><pre lang="json">
-"config-volume"
-</pre>
-</td>
-			<td></td>
-		</tr>
-		<tr>
-			<td>controller.image.repository</td>
-			<td>string</td>
-			<td><pre lang="json">
-"nginx-ingress-controller"
-</pre>
-</td>
-			<td></td>
-		</tr>
-		<tr>
-			<td>controller.image.tag</td>
-			<td>string</td>
-			<td><pre lang="json">
-"18.0831"
-</pre>
-</td>
-			<td></td>
-		</tr>
-		<tr>
-			<td>controller.name</td>
-			<td>string</td>
-			<td><pre lang="json">
-"controller"
-</pre>
-</td>
-			<td></td>
-		</tr>
-		<tr>
-			<td>controller.service.annotations."external-dns.alpha.kubernetes.io/hostname"</td>
-			<td>string</td>
-			<td><pre lang="json">
-"stupidchess.jmn23.com"
-</pre>
-</td>
-			<td>Hostname to be assigned to the ELB for the service</td>
-		</tr>
-		<tr>
-			<td>controller.service.type</td>
-			<td>string</td>
-			<td><pre lang="json">
-"LoadBalancer"
-</pre>
-</td>
-			<td></td>
-		</tr>
-	</tbody>
-</table>
 <h3>Some Section</h3>
 <table>
 	<thead>
@@ -171,3 +108,69 @@ null
 		</tr>
 	</tbody>
 </table>
+
+<h3>Other Values</h3>
+<table>
+	<thead>
+		<th>Key</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th>Description</th>
+	</thead>
+	<tbody>
+	<tr>
+		<td>controller.extraVolumes[0].name</td>
+		<td>string</td>
+		<td><pre lang="json">
+"config-volume"
+</pre>
+</td>
+		<td></td>
+	</tr>
+	<tr>
+		<td>controller.image.repository</td>
+		<td>string</td>
+		<td><pre lang="json">
+"nginx-ingress-controller"
+</pre>
+</td>
+		<td></td>
+	</tr>
+	<tr>
+		<td>controller.image.tag</td>
+		<td>string</td>
+		<td><pre lang="json">
+"18.0831"
+</pre>
+</td>
+		<td></td>
+	</tr>
+	<tr>
+		<td>controller.name</td>
+		<td>string</td>
+		<td><pre lang="json">
+"controller"
+</pre>
+</td>
+		<td></td>
+	</tr>
+	<tr>
+		<td>controller.service.annotations."external-dns.alpha.kubernetes.io/hostname"</td>
+		<td>string</td>
+		<td><pre lang="json">
+"stupidchess.jmn23.com"
+</pre>
+</td>
+		<td>Hostname to be assigned to the ELB for the service</td>
+	</tr>
+	<tr>
+		<td>controller.service.type</td>
+		<td>string</td>
+		<td><pre lang="json">
+"LoadBalancer"
+</pre>
+</td>
+		<td></td>
+	</tr>
+	</tbody>
+</table>
diff --git a/example-charts/sections/README.md.gotmpl b/example-charts/sections/README.md.gotmpl
@@ -1,5 +1,7 @@
 # Sections
 
-{{ template "chart.valuesSectionedSection" . }}
+This creates values, but sectioned into own section tables if a seciton comment is provided.
 
-{{ template "chart.valuesSectionedSectionHtml" . }}
+{{ template "chart.valuesSection" . }}
+
+{{ template "chart.valuesSectionHtml" . }}