From 9d1c8972ce36532174d1d1218a1f213263160809 Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Fri, 24 May 2024 16:22:38 +0200 Subject: [PATCH] Update Helm chart Readme links rendering (#1449) Update Helm chart Readme rendering for new docs page --- helm/botkube/README.md | 7 +++---- helm/botkube/README.tpl.md | 13 ++++++++++--- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/helm/botkube/README.md b/helm/botkube/README.md index 70809ffed..573fc0d2d 100644 --- a/helm/botkube/README.md +++ b/helm/botkube/README.md @@ -4,17 +4,16 @@ A virtual SRE, powered by AI. -**Homepage:** +**Homepage:** [https://botkube.io](https://botkube.io) ## Maintainers | Name | Email | | ---- | ------ | -| Botkube Dev Team | | +| Botkube Dev Team | [dev-team@botkube.io](mailto:dev-team@botkube.io) | ## Source Code - -* +[https://github.com/kubeshop/botkube](https://github.com/kubeshop/botkube) ## Parameters diff --git a/helm/botkube/README.tpl.md b/helm/botkube/README.tpl.md index 5fbe2cf9a..29f1e169d 100644 --- a/helm/botkube/README.tpl.md +++ b/helm/botkube/README.tpl.md @@ -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" . }}