Merge pull request #39 from kube-logging/ci-chart-doc

chore(docs): adapt helm install docs to new release artifacts
kube-logging · Aug 7, 2023 · ba82c3f · ba82c3f
2 parents b8551ba + b56b5df
commit ba82c3f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -3,20 +3,11 @@ _API managed testing tool for logging-operator_
 
 
 ##  Deploy log-generator with Helm
-Add the chart repository of the Log-generator using the following commands:
 
 ```sh
-helm repo add kube-logging https://kube-logging.github.io/helm-charts
-helm repo update
+helm install --wait --generate-name oci://ghcr.io/kube-logging/helm-charts/log-generator
 ```
 
-### Install the Log-generator.
-
-```sh
-helm install log-generator kube-logging/log-generator
-```
-
-
 ## Usage
 
 You can start the daemon serving the API on e.g. port 11000 by running the following command:

diff --git a/charts-docs/templates/overrides.gotmpl b/charts-docs/templates/overrides.gotmpl
@@ -1,19 +1,7 @@
-{{- define "chart.versionBadge" -}}
-![version: {{ .Version }}](https://img.shields.io/badge/version-{{ .Version | replace "-" "--" }}-informational?style=flat-square)
-{{- end -}}
-
 {{- define "chart.typeBadge" -}}
 {{- if .Type -}}![type: {{ .Type }}](https://img.shields.io/badge/type-{{ .Type }}-informational?style=flat-square){{- end -}}
 {{- end -}}
 
-{{- define "chart.appVersionBadge" -}}
-{{- if .AppVersion -}}![app version: {{ .AppVersion }}](https://img.shields.io/badge/app%20version-{{ .AppVersion | replace "-" "--" }}-informational?style=flat-square){{- end -}}
-{{- end -}}
-
-{{- define "chart.kubeVersionBadge" -}}
-{{- if .KubeVersion -}}![kube version: {{ .KubeVersion }}](https://img.shields.io/badge/kube%20version-{{ .KubeVersion | replace "-" "--" }}-informational?style=flat-square){{- end -}}
-{{- end -}}
-
 {{- define "chart.artifactHubBadge" -}}
 [![artifact hub](https://img.shields.io/badge/artifact%20hub-{{ .Name | replace "-" "--" }}-informational?style=flat-square)](https://artifacthub.io/packages/helm/kube-logging/{{ .Name }})
 {{- end -}}
@@ -22,8 +10,7 @@
 ## TL;DR;
 
 ```bash
-helm repo add kube-logging https://kube-logging.github.io/helm-charts
-helm install --generate-name --wait kube-logging/{{ .Name }}
+helm install --wait --generate-name oci://ghcr.io/kube-logging/helm-charts/{{ .Name }}
 ```
 {{- end -}}
 

diff --git a/charts/log-generator/README.md b/charts/log-generator/README.md
@@ -7,8 +7,7 @@ A Helm chart for Log-generator
 ## TL;DR;
 
 ```bash
-helm repo add kube-logging https://kube-logging.github.io/helm-charts
-helm install --generate-name --wait kube-logging/log-generator
+helm install --wait --generate-name oci://ghcr.io/kube-logging/helm-charts/log-generator
 ```
 
 ## Values