Skip to content

Commit

Permalink
Update Helm chart Readme links rendering (#1449)
Browse files Browse the repository at this point in the history
Update Helm chart Readme rendering for new docs page
  • Loading branch information
pkosiec committed May 24, 2024
1 parent 3da45e9 commit 9d1c897
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
7 changes: 3 additions & 4 deletions helm/botkube/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@

A virtual SRE, powered by AI.

**Homepage:** <https://botkube.io>
**Homepage:** [https://botkube.io](https://botkube.io)

## Maintainers

| Name | Email |
| ---- | ------ |
| Botkube Dev Team | <[email protected]> |
| Botkube Dev Team | [[email protected]](mailto:[email protected]) |

## Source Code

* <https://github.com/kubeshop/botkube>
[https://github.com/kubeshop/botkube](https://github.com/kubeshop/botkube)

## Parameters

Expand Down
13 changes: 10 additions & 3 deletions helm/botkube/README.tpl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,26 @@

{{ template "chart.description" . }}

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

{{ define "chart.maintainersTable" }}
| Name | Email |
| ---- | ------ |
{{- range .Maintainers }}
| {{ .Name }} | {{ if .Email }}<{{ .Email }}>{{ end }} |
| {{ .Name }} | {{ if .Email }}[{{ .Email }}](mailto:{{ .Email }}){{ end }} |
{{- end }}
{{ end }}

{{ template "chart.maintainersSection" . }}

{{ template "chart.sourcesSection" . }}

{{ if .Sources }}
## Source Code

{{- range .Sources }}
[{{ . }}]({{ . }})
{{- end }}
{{ end }}

{{ template "chart.requirementsSection" . }}

Expand Down

0 comments on commit 9d1c897

Please sign in to comment.