Skip to content

Commit 9d1c897

Browse files
authored
Update Helm chart Readme links rendering (#1449)
Update Helm chart Readme rendering for new docs page
1 parent 3da45e9 commit 9d1c897

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

helm/botkube/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,16 @@
44

55
A virtual SRE, powered by AI.
66

7-
**Homepage:** <https://botkube.io>
7+
**Homepage:** [https://botkube.io](https://botkube.io)
88

99
## Maintainers
1010

1111
| Name | Email |
1212
| ---- | ------ |
13-
| Botkube Dev Team | <[email protected]> |
13+
| Botkube Dev Team | [[email protected]](mailto:[email protected]) |
1414

1515
## Source Code
16-
17-
* <https://github.com/kubeshop/botkube>
16+
[https://github.com/kubeshop/botkube](https://github.com/kubeshop/botkube)
1817

1918
## Parameters
2019

helm/botkube/README.tpl.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,26 @@
44

55
{{ template "chart.description" . }}
66

7-
{{ template "chart.homepageLine" . }}
7+
{{ if .Home }}**Homepage:** [{{ .Home }}]({{ .Home }}){{ end }}
88

99
{{ define "chart.maintainersTable" }}
1010
| Name | Email |
1111
| ---- | ------ |
1212
{{- range .Maintainers }}
13-
| {{ .Name }} | {{ if .Email }}<{{ .Email }}>{{ end }} |
13+
| {{ .Name }} | {{ if .Email }}[{{ .Email }}](mailto:{{ .Email }}){{ end }} |
1414
{{- end }}
1515
{{ end }}
1616

1717
{{ template "chart.maintainersSection" . }}
1818

19-
{{ template "chart.sourcesSection" . }}
19+
20+
{{ if .Sources }}
21+
## Source Code
22+
23+
{{- range .Sources }}
24+
[{{ . }}]({{ . }})
25+
{{- end }}
26+
{{ end }}
2027

2128
{{ template "chart.requirementsSection" . }}
2229

0 commit comments

Comments
 (0)