From 1fd74afcc00b82f8db533a21a2d3650821569bc7 Mon Sep 17 00:00:00 2001
From: Nacho Barrientos <nacho.barrientos@cern.ch>
Date: Mon, 17 Mar 2025 11:54:08 +0100
Subject: [PATCH] Reword chart's short description
---
Chart.yaml | 2 +-
README.md | 6 ++++--
README.md.gotmpl | 5 ++++-
3 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/Chart.yaml b/Chart.yaml
index c51e87c..a95dc52 100644
--- a/Chart.yaml
+++ b/Chart.yaml
@@ -3,7 +3,7 @@ name: cern-it-monitoring-kubernetes
version: 0.0.0 # DO NOT UPDATE MANUALLY!
type: application
kubeVersion: ">=1.27.0-0"
-description: Helm Chart provided by IT Monitoring Service to install and configure required components to gather and send monitoring data from kubernetes clusters to central service.
+description: Helm Chart provided by the IT Monitoring Service to install and configure the required components to gather and send monitoring data from Kubernetes clusters to the central service.
home: https://cern.ch/monitoring
dependencies:
- name: crds
diff --git a/README.md b/README.md
index 16fdafa..8bb5ab1 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
# cern-it-monitoring-kubernetes
-Helm Chart provided by IT Monitoring Service to install and configure required components to gather and send monitoring data from kubernetes clusters to central service.
+## Short description
-## Overview
+Helm Chart provided by the IT Monitoring Service to install and configure the required components to gather and send monitoring data from Kubernetes clusters to the central service.
+
+## Details
The **CERN IT Monitoring Kubernetes Helm Chart** provides a solution
for monitoring Kubernetes clusters at CERN. It enables the collection
diff --git a/README.md.gotmpl b/README.md.gotmpl
index 76973b0..cbc3949 100644
--- a/README.md.gotmpl
+++ b/README.md.gotmpl
@@ -1,7 +1,10 @@
{{ template "chart.header" . }}
+
+## Short description
+
{{ template "chart.description" . }}
-## Overview
+## Details
The **CERN IT Monitoring Kubernetes Helm Chart** provides a solution
for monitoring Kubernetes clusters at CERN. It enables the collection
--
GitLab