Skip to content

Commit 60d02b1

Browse files
HaepaxlogHaepaxlog
committed
Change example section chart to new templates
1 parent 84eb04f commit 60d02b1

File tree

3 files changed

+83
-85
lines changed

3 files changed

+83
-85
lines changed

‎example-charts/sections/Chart.yaml

+1-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
apiVersion: v2
22
name: sections
3-
deprecated: true
43
version: "1.0.0"
54
type: application
65
appVersion: "13.0.0"
@@ -10,10 +9,4 @@ maintainers:
109
- email: [email protected]
1110
name: Constantin Rohde
1211
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/sections"]
13-
kubeVersion: "<=1.18"
14-
engine: gotpl
15-
16-
dependencies:
17-
- name: nginx-ingress
18-
version: "0.22.1"
19-
repository: "@stable"
12+
engine: gotpl

‎example-charts/sections/README.md

+78-75
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
# Sections
22

3-
## Values
3+
This creates values, but sectioned into own section tables if a seciton comment is provided.
44

5-
### General
6-
| Key | Type | Default | Description |
7-
|-----|------|---------|-------------|
8-
| controller.extraVolumes[0].name | string | `"config-volume"` | |
9-
| controller.image.repository | string | `"nginx-ingress-controller"` | |
10-
| controller.image.tag | string | `"18.0831"` | |
11-
| controller.name | string | `"controller"` | |
12-
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
13-
| controller.service.type | string | `"LoadBalancer"` | |
5+
## Values
146

157
### Some Section
168
| Key | Type | Default | Description |
@@ -26,73 +18,18 @@
2618
| controller.publishService | object | `{"enabled":false}` | This is a publishService |
2719
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
2820

21+
### Other Values
22+
| Key | Type | Default | Description |
23+
|-----|------|---------|-------------|
24+
| controller.extraVolumes[0].name | string | `"config-volume"` | |
25+
| controller.image.repository | string | `"nginx-ingress-controller"` | |
26+
| controller.image.tag | string | `"18.0831"` | |
27+
| controller.name | string | `"controller"` | |
28+
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
29+
| controller.service.type | string | `"LoadBalancer"` | |
30+
2931
## Values
3032

31-
<h3>General</h3>
32-
<table>
33-
<thead>
34-
<th>Key</th>
35-
<th>Type</th>
36-
<th>Default</th>
37-
<th>Description</th>
38-
</thead>
39-
<tbody>
40-
<tr>
41-
<td>controller.extraVolumes[0].name</td>
42-
<td>string</td>
43-
<td><pre lang="json">
44-
"config-volume"
45-
</pre>
46-
</td>
47-
<td></td>
48-
</tr>
49-
<tr>
50-
<td>controller.image.repository</td>
51-
<td>string</td>
52-
<td><pre lang="json">
53-
"nginx-ingress-controller"
54-
</pre>
55-
</td>
56-
<td></td>
57-
</tr>
58-
<tr>
59-
<td>controller.image.tag</td>
60-
<td>string</td>
61-
<td><pre lang="json">
62-
"18.0831"
63-
</pre>
64-
</td>
65-
<td></td>
66-
</tr>
67-
<tr>
68-
<td>controller.name</td>
69-
<td>string</td>
70-
<td><pre lang="json">
71-
"controller"
72-
</pre>
73-
</td>
74-
<td></td>
75-
</tr>
76-
<tr>
77-
<td>controller.service.annotations."external-dns.alpha.kubernetes.io/hostname"</td>
78-
<td>string</td>
79-
<td><pre lang="json">
80-
"stupidchess.jmn23.com"
81-
</pre>
82-
</td>
83-
<td>Hostname to be assigned to the ELB for the service</td>
84-
</tr>
85-
<tr>
86-
<td>controller.service.type</td>
87-
<td>string</td>
88-
<td><pre lang="json">
89-
"LoadBalancer"
90-
</pre>
91-
</td>
92-
<td></td>
93-
</tr>
94-
</tbody>
95-
</table>
9633
<h3>Some Section</h3>
9734
<table>
9835
<thead>
@@ -171,3 +108,69 @@ null
171108
</tr>
172109
</tbody>
173110
</table>
111+
112+
<h3>Other Values</h3>
113+
<table>
114+
<thead>
115+
<th>Key</th>
116+
<th>Type</th>
117+
<th>Default</th>
118+
<th>Description</th>
119+
</thead>
120+
<tbody>
121+
<tr>
122+
<td>controller.extraVolumes[0].name</td>
123+
<td>string</td>
124+
<td><pre lang="json">
125+
"config-volume"
126+
</pre>
127+
</td>
128+
<td></td>
129+
</tr>
130+
<tr>
131+
<td>controller.image.repository</td>
132+
<td>string</td>
133+
<td><pre lang="json">
134+
"nginx-ingress-controller"
135+
</pre>
136+
</td>
137+
<td></td>
138+
</tr>
139+
<tr>
140+
<td>controller.image.tag</td>
141+
<td>string</td>
142+
<td><pre lang="json">
143+
"18.0831"
144+
</pre>
145+
</td>
146+
<td></td>
147+
</tr>
148+
<tr>
149+
<td>controller.name</td>
150+
<td>string</td>
151+
<td><pre lang="json">
152+
"controller"
153+
</pre>
154+
</td>
155+
<td></td>
156+
</tr>
157+
<tr>
158+
<td>controller.service.annotations."external-dns.alpha.kubernetes.io/hostname"</td>
159+
<td>string</td>
160+
<td><pre lang="json">
161+
"stupidchess.jmn23.com"
162+
</pre>
163+
</td>
164+
<td>Hostname to be assigned to the ELB for the service</td>
165+
</tr>
166+
<tr>
167+
<td>controller.service.type</td>
168+
<td>string</td>
169+
<td><pre lang="json">
170+
"LoadBalancer"
171+
</pre>
172+
</td>
173+
<td></td>
174+
</tr>
175+
</tbody>
176+
</table>

‎example-charts/sections/README.md.gotmpl

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Sections
22

3-
{{ template "chart.valuesSectionedSection" . }}
3+
This creates values, but sectioned into own section tables if a seciton comment is provided.
44

5-
{{ template "chart.valuesSectionedSectionHtml" . }}
5+
{{ template "chart.valuesSection" . }}
6+
7+
{{ template "chart.valuesSectionHtml" . }}

0 commit comments

Comments
 (0)