Skip to content

Commit 61d5caf

Browse files
Artus-LHINDArtus-LHIND
committed
feat: fixed and updated READMEs
1 parent 64ad9ea commit 61d5caf

File tree

10 files changed

+112
-42
lines changed

10 files changed

+112
-42
lines changed

‎README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,19 @@ If there is no `README.md.gotmpl` (or other specified gotmpl file) present, the
120120
That template looks like so:
121121
```
122122
{{ template "chart.header" . }}
123+
{{ template "chart.deprecationWarning" . }}
124+
125+
{{ template "chart.versionBadge" . }}
126+
{{ template "chart.typeBadge" . }}
127+
{{ template "chart.appVersionBadge" . }}
128+
123129
{{ template "chart.description" . }}
124130
125-
{{ template "chart.versionLine" . }}
131+
{{ template "chart.homepageLine" . }}
132+
133+
{{ template "chart.maintainersSection" . }}
126134
127-
{{ template "chart.sourceLinkLine" . }}
135+
{{ template "chart.sourcesSection" . }}
128136
129137
{{ template "chart.requirementsSection" . }}
130138

‎example-charts/custom-template/README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
custom-template
2-
===============
1+
# custom-template
2+
33
Basically the same as the nginx-ingress chart, but using a custom template to include some other content
44

55
Current chart version is `0.2.0`
66

7-
Source code can be found [here](https://github.com/norwoodj/helm-docs/tree/master/example-charts/custom-template)
8-
97
## Additional Information
108
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
119
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
1210
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
1311
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
1412
culpa qui officia deserunt mollit anim id est laborum.
1513

16-
## Chart Requirements
14+
## Requirements
1715

1816
| Repository | Name | Version |
1917
|------------|------|---------|
2018
| @stable | nginx-ingress | 0.22.1 |
2119

22-
## Chart Values
20+
## Values
2321

2422
| Key | Type | Default | Description |
2523
|-----|------|---------|-------------|

‎example-charts/custom-template/README.md.gotmpl

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33

44
{{ template "chart.versionLine" . }}
55

6-
{{ template "chart.sourceLinkLine" . }}
7-
86
## Additional Information
97
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
108
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut

‎example-charts/helm-3/README.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
nginx-ingress
2-
=============
1+
# nginx-ingress
2+
3+
4+
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
6+
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
7+
8+
39
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
410

5-
Current chart version is `0.2.0`
11+
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
12+
13+
## Maintainers
14+
15+
| Name | Email | Url |
16+
| ---- | ------ | --- |
17+
| John Norwood | [email protected] | |
18+
19+
## Source Code
620

7-
Source code can be found [here](https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress)
21+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
822

9-
## Chart Requirements
23+
## Requirements
1024

1125
| Repository | Name | Version |
1226
|------------|------|---------|
1327
| @stable | nginx-ingress | 0.22.1 |
1428

15-
## Chart Values
29+
## Values
1630

1731
| Key | Type | Default | Description |
1832
|-----|------|---------|-------------|

‎example-charts/most-empty/README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
most-empty
2-
==========
1+
# most-empty
32

43

5-
Current chart version is `0.2.0`
6-
74

5+
Current chart version is `0.2.0`
86

97
This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
108
`requirements`, and `values` are all empty and don't appear here.

‎example-charts/most-empty/README.md.gotmpl

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33

44
{{ template "chart.versionLine" . }}
55

6-
{{ template "chart.sourceLinkLine" . }}
7-
86
This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
97
`requirements`, and `values` are all empty and don't appear here.
108

‎example-charts/nginx-ingress/README.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
nginx-ingress
2-
=============
1+
# nginx-ingress
2+
3+
4+
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
6+
7+
8+
39
A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
410

5-
Current chart version is `0.2.0`
11+
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
12+
13+
## Maintainers
14+
15+
| Name | Email | Url |
16+
| ---- | ------ | --- |
17+
| John Norwood | [email protected] | |
18+
19+
## Source Code
620

7-
Source code can be found [here](https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress)
21+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>
822

9-
## Chart Requirements
23+
## Requirements
1024

1125
| Repository | Name | Version |
1226
|------------|------|---------|
1327
| @stable | nginx-ingress | 0.22.1 |
1428

15-
## Chart Values
29+
## Values
1630

1731
| Key | Type | Default | Description |
1832
|-----|------|---------|-------------|

‎example-charts/no-requirements/README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
1-
no-requirements
2-
===============
1+
# no-requirements
2+
3+
4+
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
6+
7+
8+
39
A simple chart that installs, let's say PrometheusRules, that needs no sub-charts
410

5-
Current chart version is `0.2.0`
11+
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>
12+
13+
## Maintainers
14+
15+
| Name | Email | Url |
16+
| ---- | ------ | --- |
17+
| John Norwood | [email protected] | |
18+
19+
## Source Code
620

7-
Source code can be found [here](https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements)
21+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>
822

923

1024

11-
## Chart Values
25+
## Values
1226

1327
| Key | Type | Default | Description |
1428
|-----|------|---------|-------------|

‎example-charts/no-values/README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
1-
no-values
2-
=========
1+
# no-values
2+
3+
4+
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
6+
7+
8+
39
A very simple chart that doesn't even need any values for customization
410

5-
Current chart version is `0.2.0`
11+
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>
12+
13+
## Maintainers
14+
15+
| Name | Email | Url |
16+
| ---- | ------ | --- |
17+
| John Norwood | [email protected] | |
18+
19+
## Source Code
620

7-
Source code can be found [here](https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values)
21+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>
822

923

1024

‎example-charts/special-characters/README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
1-
special-characters
2-
==================
1+
# special-characters
2+
3+
4+
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
6+
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
7+
8+
39
A chart demonstrating handling of special characters in values files
410

5-
Current chart version is `0.2.0`
11+
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
12+
13+
## Maintainers
14+
15+
| Name | Email | Url |
16+
| ---- | ------ | --- |
17+
| John Norwood | [email protected] | |
18+
19+
## Source Code
620

7-
Source code can be found [here](https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters)
21+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>
822

923

1024

11-
## Chart Values
25+
## Values
1226

1327
| Key | Type | Default | Description |
1428
|-----|------|---------|-------------|

0 commit comments

Comments
 (0)