Changed: updated Readme (#314)

Co-authored-by: fbrintazzoli <filippo.brintazzoli@clear.ml>
allegroai · Aug 19, 2024 · adcb4b0 · adcb4b0
1 parent 873f222
commit adcb4b0
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/charts/clearml/Chart.yaml b/charts/clearml/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: clearml
 description: MLOps platform
 type: application
-version: "7.11.1"
+version: "7.11.2"
 appVersion: "1.16"
 kubeVersion: ">= 1.21.0-0 < 1.31.0-0"
 home: https://clear.ml
@@ -11,8 +11,8 @@ sources:
   - https://github.com/allegroai/clearml-helm-charts
   - https://github.com/allegroai/clearml
 maintainers:
-  - name: valeriano-manassero
-    url: https://github.com/valeriano-manassero
+  - name: filippo-clearml
+    url: https://github.com/filippo-clearml
 keywords:
   - clearml
   - "machine learning"
@@ -33,4 +33,4 @@ dependencies:
 annotations:
   artifacthub.io/changes: |
     - kind: changed
-      description: app version 1.16.1
+      description: Updated README
diff --git a/charts/clearml/README.md b/charts/clearml/README.md
@@ -1,6 +1,6 @@
 # ClearML Ecosystem for Kubernetes
 
-![Version: 7.11.1](https://img.shields.io/badge/Version-7.11.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16](https://img.shields.io/badge/AppVersion-1.16-informational?style=flat-square)
+![Version: 7.11.2](https://img.shields.io/badge/Version-7.11.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16](https://img.shields.io/badge/AppVersion-1.16-informational?style=flat-square)
 
 MLOps platform
 
@@ -10,7 +10,7 @@ MLOps platform
 
 | Name | Email | Url |
 | ---- | ------ | --- |
-| valeriano-manassero |  | <https://github.com/valeriano-manassero> |
+| filippo-clearml |  | <https://github.com/filippo-clearml> |
 
 ## Introduction
 
@@ -25,6 +25,14 @@ It allows multiple users to collaborate and manage their experiments.
     * Querying experiments history, logs and results
 * Locally-hosted file server for storing images and models making them easily accessible using the Web-App
 
+## Add to local Helm repository
+
+To add this chart to your local Helm repository:
+
+```
+helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
+```
+
 ## Local environment
 
 For development/evaluation it's possible to use [kind](https://kind.sigs.k8s.io).

diff --git a/charts/clearml/README.md.gotmpl b/charts/clearml/README.md.gotmpl
@@ -22,6 +22,14 @@ It allows multiple users to collaborate and manage their experiments.
     * Querying experiments history, logs and results
 * Locally-hosted file server for storing images and models making them easily accessible using the Web-App
 
+## Add to local Helm repository
+
+To add this chart to your local Helm repository:
+
+```
+helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
+```
+
 ## Local environment
 
 For development/evaluation it's possible to use [kind](https://kind.sigs.k8s.io).