From 0be36ebee47efd2d85912f96c9556490c4fc615f Mon Sep 17 00:00:00 2001
From: Gaspard FEREY <gaspard.ferey@insee.fr>
Date: Thu, 9 Jan 2025 16:28:12 +0100
Subject: [PATCH] Fixing NOTES doc, style and spacing

---
 charts/library-chart/Chart.yaml           |  2 +-
 charts/library-chart/templates/_notes.tpl | 19 +++++++++++++++----
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/charts/library-chart/Chart.yaml b/charts/library-chart/Chart.yaml
index 0f933993..72a5c43a 100644
--- a/charts/library-chart/Chart.yaml
+++ b/charts/library-chart/Chart.yaml
@@ -1,4 +1,4 @@
 apiVersion: v2
 name: library-chart
-version: 1.5.38
+version: 1.5.39
 type: library
diff --git a/charts/library-chart/templates/_notes.tpl b/charts/library-chart/templates/_notes.tpl
index 5dca7397..4866ed9d 100644
--- a/charts/library-chart/templates/_notes.tpl
+++ b/charts/library-chart/templates/_notes.tpl
@@ -32,9 +32,9 @@ Vous pouvez tout de même y accéder en executant la commande suivante depuis un
 `kubectl port-forward service/{{ include "library-chart.fullname" . }} <port-local>:{{ .Values.networking.service.port }}`
 puis en vous connectant depuis votre navigateur à l'URL suivante : `http://localhost:<port-local>`
 {{ end -}}
-{{- with (.Values.environment).user }}
+{{- with (.Values.environment).user -}}
 - Votre nom d'utilisateur: {{ . }}
-{{- end -}}
+{{ end -}}
 - Votre password: {{ .Values.security.password }}
 {{ else -}}
 {{- if or (.Values.ingress).enabled (.Values.route).enabled }}
@@ -45,9 +45,9 @@ You can still access it by running the following command from a terminal:
 `kubectl port-forward service/{{ include "library-chart.fullname" . }} <local-port>:{{ .Values.networking.service.port }}`
 and then use the following URL with your browser: `http://localhost:<local-port>`
 {{ end -}}
-{{- with (.Values.environment).user }}
+{{- with (.Values.environment).user -}}
 - Your user name: {{ . }}
-{{- end -}}
+{{ end -}}
 - Your password: {{ .Values.security.password }}
 {{ end -}}
 {{- end -}}
@@ -124,6 +124,13 @@ If you access these URL without starting the corresponding services you will get
 
 {{/*
   Generate NOTES about service deletion.
+
+  Usage:
+    {{ include "library-chart.notes-deletion" (dict "serviceName" "Visual Studio Code" "context" $) }}
+
+  Params:
+    - serviceName - String - Optional. The human readable name of the service.
+    - context - Dict - Required. The context for the template evaluation.
 */}}
 {{- define "library-chart.notes-deletion" -}}
 {{- $serviceName := .serviceName | default .context.Chart.Name -}}
@@ -131,20 +138,24 @@ If you access these URL without starting the corresponding services you will get
 {{- if not (and (.Values.persistence).enabled .Values.persistence.existingClaim) -}}
 {{- if eq .Values.userPreferences.language "fr" }}
 **REMARQUES concernant la suppression :**
+
 Votre répertoire de travail `/home/{{ .Values.environment.user }}/work`
 sera **immédiatement effacé** à la suppression de votre service {{ $serviceName }}.
 Assurez-vous de sauvegarder toutes vos ressources de travail sur des supports persistants :
 - Votre code peux être stocké dans une forge logicielle telle que git.
 - Vos données et modèles peuvent être stockés dans un système de stockage objet tel que S3.
+
 Il est possible d'associer un script d'initialisation à votre service pour mettre en place un environnement de travail sur mesure
 (télécharger vos ressources, installer les bibliothèques et outils dont vous avez besoin, configurer votre service, etc.)
 {{ else }}
 **NOTES about deletion:**
+
 Your work directory `/home/{{ .Values.environment.user }}/work`
 will be **immediately deleted** upon the termination of your {{ $serviceName }} service.
 Make sure to save all your work resources on persistent storage:
 - Your code can be stored in a version control system such as git.
 - Your data and models can be stored in an object storage system such as S3.
+
 It is possible to associate an initialization script with your service to set up a customized working environment
 (download your resources, install the libraries and tools you need, configure your service, etc.).
 {{ end -}}