Change readme language according to user preferences (#100)

* add french language to notes for jupyter python * fix * add french notes * bump version * bump version * fix NOTES.txt --------- Co-authored-by: Romain Avouac <[email protected]>
InseeFrLab · Oct 20, 2023 · a4e7a4c · a4e7a4c
1 parent e9480fb
commit a4e7a4c
Show file tree

Hide file tree

Showing 24 changed files with 302 additions and 45 deletions.
diff --git a/charts/jupyter-pyspark/Chart.yaml b/charts/jupyter-pyspark/Chart.yaml
@@ -24,7 +24,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.32.17
+version: 1.32.18
 
 dependencies:
   - name: library-chart

diff --git a/charts/jupyter-pyspark/templates/NOTES.txt b/charts/jupyter-pyspark/templates/NOTES.txt
@@ -1,3 +1,40 @@
+{{- if eq .Values.userPreferences.language "fr"}}
+{{- if .Values.ingress.enabled }}
+- Vous pouvez vous connecter à ce Jupyter avec votre navigateur en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
+{{- if .Values.spark.sparkui }}
+- Lorsque le driver Spark est en cours d'exécution, vous pouvez vous connecter à l'interface Spark-UI avec votre navigateur en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.sparkHostname }})
+{{- end }}
+{{- end }}
+{{- if .Values.route.enabled }}
+- Vous pouvez vous connecter à ce Jupyter avec votre navigateur en utilisant ce [lien](https://{{ .Values.route.hostname }})
+{{- if .Values.spark.sparkui }}
+- Lorsque le driver Spark est en cours d'exécution, vous pouvez vous connecter à l'interface Spark-UI avec votre navigateur en utilisant ce [lien](https://{{ .Values.route.sparkHostname }})
+{{- end }}
+{{- end }}
+- Votre jeton d'accès est **{{ .Values.security.password }}**
+
+{{- if .Values.ingress.enabled }}
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.userHostname }})
+Si vous ne lancez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+{{- if .Values.route.enabled }}
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé en utilisant ce [lien](https://{{ .Values.route.userHostname }})
+Si vous ne lancez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+
+*REMARQUES concernant la suppression :*
+
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+- Le volume associé au chemin suivant {{ .Values.persistence.mountPath }} sera supprimé
+- Par conséquent, vous devriez sauvegarder votre code dans un dépôt Git externe
+- Vous devriez également sauvegarder vos données dans un référentiel de données externe tel que S3
+- Vous pouvez facilement créer un nouveau service {{ .Chart.Name }}, cloner votre code et réinstaller les bibliothèques dont vous avez besoin
+{{- end }}
+{{- else }}
 {{- if .Values.ingress.enabled }}
 - You can connect to this jupyter with your browser on this [link](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
 {{- if .Values.spark.sparkui }}
@@ -33,3 +70,4 @@ If you don't run your custom service you will get a 502 bad gateway error.
 - So, You should save your data to an external data repository like S3
 - You can easily create a new {{ .Chart.Name }} service, clone your code and install again some librairies you need
 {{- end }}
+{{- end }}
diff --git a/charts/jupyter-pyspark/values.schema.json b/charts/jupyter-pyspark/values.schema.json
@@ -888,6 +888,15 @@
           "hidden": true,
           "overwriteDefaultWith": "user.darkMode"
           }
+        },
+        "language": {
+          "type": "string",
+          "description": "Preferred language",
+          "default": "en",
+          "x-onyxia": {
+            "hidden": true,
+            "overwriteDefaultWith": "user.lang"
+          }
         }
       }
     }

diff --git a/charts/jupyter-pyspark/values.yaml b/charts/jupyter-pyspark/values.yaml
@@ -238,3 +238,4 @@ startupProbe:
 
 userPreferences:
   darkMode: false
+  language: "en"
diff --git a/charts/jupyter-python/Chart.yaml b/charts/jupyter-python/Chart.yaml
@@ -22,7 +22,8 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.13.11
+
+version: 1.13.12
 
 dependencies:
   - name: library-chart

diff --git a/charts/jupyter-python/templates/NOTES.txt b/charts/jupyter-python/templates/NOTES.txt
@@ -1,3 +1,29 @@
+{{- if eq .Values.userPreferences.language "fr" }}
+{{- if .Values.ingress.enabled }}
+- Vous pouvez vous connecter à ce Jupyter avec votre navigateur en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }}).
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.userHostname }}).
+Si vous ne lancez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+{{- if .Values.route.enabled }}
+- Vous pouvez vous connecter à ce Jupyter avec votre navigateur en utilisant ce [lien](https://{{ .Values.route.hostname }}).
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé en utilisant ce [lien](https://{{ .Values.route.userHostname }})
+Si vous ne lancez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+- Votre jeton d'accès est **{{ .Values.security.password }}**
+
+*NOTES concernant la suppression :*
+
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+- Le volume associé au chemin suivant {{ .Values.persistence.mountPath }} sera supprimé.
+- Par conséquent, vous devriez sauvegarder votre code dans un référentiel Git externe.
+- Vous devriez également sauvegarder vos données dans un référentiel de données externe tel que S3.
+- Vous pouvez facilement créer un nouveau service {{ .Chart.Name }}, cloner votre code et réinstaller les bibliothèques dont vous avez besoin.
+{{- end }}
+{{- else }}
 {{- if .Values.ingress.enabled }}
 - You can connect to this jupyter with your browser on this [link](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
 {{- if .Values.networking.user.enabled }}
@@ -22,3 +48,4 @@ If you don't run your custom service you will get a 502 bad gateway error.
 - So, You should save your data to an external data repository like S3
 - You can easily create a new {{ .Chart.Name }} service, clone your code and install again some librairies you need
 {{- end }}
+{{- end }}
diff --git a/charts/jupyter-python/values.schema.json b/charts/jupyter-python/values.schema.json
@@ -776,19 +776,28 @@
             }
         },
         "userPreferences":{
-          "description": "User Preferences",
-          "type": "object",
-          "properties": {
-            "darkMode": {
-              "type": "boolean",
-              "description": "dark mode is or is not enabled",
-              "default": false,
-            "x-onyxia": {
-              "hidden": true,
-              "overwriteDefaultWith": "user.darkMode"
-              }
+            "description": "User Preferences",
+            "type": "object",
+            "properties": {
+                "darkMode": {
+                    "type": "boolean",
+                    "description": "dark mode is or is not enabled",
+                    "default": false,
+                    "x-onyxia": {
+                        "hidden": true,
+                        "overwriteDefaultWith": "user.darkMode"
+                    }
+                },
+                "language": {
+                    "type": "string",
+                    "description": "Preferred language",
+                    "default": "en",
+                    "x-onyxia": {
+                        "hidden": true,
+                        "overwriteDefaultWith": "user.lang"
+                    }
+                }
             }
-          }
         }
     }
 }
diff --git a/charts/jupyter-python/values.yaml b/charts/jupyter-python/values.yaml
@@ -208,3 +208,4 @@ startupProbe:
 
 userPreferences:
   darkMode: false
+  language: "en"
diff --git a/charts/rstudio-sparkr/Chart.yaml b/charts/rstudio-sparkr/Chart.yaml
@@ -23,7 +23,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.16.9
+version: 1.16.10
 
 dependencies:
   - name: library-chart

diff --git a/charts/rstudio-sparkr/templates/NOTES.txt b/charts/rstudio-sparkr/templates/NOTES.txt
@@ -1,3 +1,41 @@
+{{- if eq .Values.userPreferences.language "fr"}}
+{{- if .Values.ingress.enabled }}
+- Vous pouvez vous connecter à cet RStudio avec votre navigateur sur ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
+{{- if .Values.spark.sparkui }}
+- Lorsque le pilote Spark est en cours d'exécution, vous pouvez vous connecter à l'interface Spark avec votre navigateur en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.sparkHostname }})
+{{- end }}
+{{- end }}
+{{- if .Values.route.enabled }}
+- Vous pouvez vous connecter à cet RStudio avec votre navigateur en utilisant ce [lien](https://{{ .Values.route.hostname }})
+{{- if .Values.spark.sparkui }}
+- Lorsque le pilote Spark est en cours d'exécution, vous pouvez vous connecter à l'interface Spark avec votre navigateur en utilisant ce [lien](https://{{ .Values.route.sparkHostname }})
+{{- end }}
+{{- end }}
+- Le nom d'utilisateur est **{{ .Values.environment.user }}**
+- Le mot de passe est  **{{ .Values.security.password }}**
+
+{{- if .Values.ingress.enabled }}
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé en utilisant ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.userHostname }})
+Si vous n'exécutez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+{{- if .Values.route.enabled }}
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé en utilisant ce [lien](https://{{ .Values.route.userHostname }})
+Si vous n'exécutez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+
+*REMARQUES sur la suppression :*
+
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+- Le volume associé au chemin suivant {{ .Values.persistence.mountPath }} sera supprimé
+- Vous devriez donc sauvegarder votre code dans un dépôt Git externe
+- Vous devriez aussi sauvegarder vos données dans un référentiel de données externe tel que S3
+- Vous pouvez facilement créer un nouveau service {{ .Chart.Name }}, cloner votre code et réinstaller les bibliothèques dont vous avez besoin
+{{- end }}
+{{- else}}
 {{- if .Values.ingress.enabled }}
 - You can connect to this rstudio with your browser on this [link](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
 {{- if .Values.spark.sparkui }}
@@ -34,3 +72,4 @@ If you don't run your custom service you will get a 502 bad gateway error.
 - So, You should save your data to an external data repository like S3
 - You can easily create a new {{ .Chart.Name }} service, clone your code and install again some librairies you need
 {{- end }}
+{{- end }}
diff --git a/charts/rstudio-sparkr/values.schema.json b/charts/rstudio-sparkr/values.schema.json
@@ -823,19 +823,28 @@
             }
         },
         "userPreferences":{
-          "description": "User Preferences",
-          "type": "object",
-          "properties": {
-            "darkMode": {
-              "type": "boolean",
-              "description": "dark mode is or is not enabled",
-              "default": false,
-            "x-onyxia": {
-              "hidden": true,
-              "overwriteDefaultWith": "user.darkMode"
-              }
+            "description": "User Preferences",
+            "type": "object",
+            "properties": {
+                "darkMode": {
+                    "type": "boolean",
+                    "description": "dark mode is or is not enabled",
+                    "default": false,
+                    "x-onyxia": {
+                        "hidden": true,
+                        "overwriteDefaultWith": "user.darkMode"
+                    }
+                },
+                "language": {
+                    "type": "string",
+                    "description": "Preferred language",
+                    "default": "en",
+                    "x-onyxia": {
+                        "hidden": true,
+                        "overwriteDefaultWith": "user.lang"
+                    }
+                }
             }
-          }
         }
     }
 }
diff --git a/charts/rstudio-sparkr/values.yaml b/charts/rstudio-sparkr/values.yaml
@@ -221,3 +221,4 @@ repository:
 
 userPreferences:
   darkMode: false
+  language: "en"
diff --git a/charts/rstudio/Chart.yaml b/charts/rstudio/Chart.yaml
@@ -22,7 +22,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.15.8
+version: 1.15.9
 
 dependencies:
   - name: library-chart

diff --git a/charts/rstudio/templates/NOTES.txt b/charts/rstudio/templates/NOTES.txt
@@ -1,3 +1,35 @@
+{{- if eq .Values.userPreferences.language "fr"}}
+{{- if .Values.ingress.enabled }}
+- Vous pouvez vous connecter à ce RStudio avec votre navigateur sur ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
+{{- end }}
+{{- if .Values.route.enabled }}
+- Vous pouvez vous connecter à ce RStudio avec votre navigateur sur ce [lien](https://{{ .Values.route.hostname }})
+{{- end }}
+- Le nom d'utilisateur est {{ .Values.environment.user }}
+- Le mot de passe est **{{ .Values.security.password }}**
+
+{{- if .Values.ingress.enabled }}
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé sur ce [lien](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.userHostname }})
+- Si vous n'exécutez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+{{- if .Values.route.enabled }}
+{{- if .Values.networking.user.enabled }}
+- Vous pouvez vous connecter à votre port personnalisé sur ce [lien](https://{{ .Values.route.userHostname }})
+- Si vous n'exécutez pas votre service personnalisé, vous obtiendrez une erreur 502 Bad Gateway.
+{{- end }}
+{{- end }}
+
+*REMARQUES sur la suppression :*
+
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+- Le volume associé au chemin suivant {{ .Values.persistence.mountPath }} sera supprimé
+- Vous devriez donc sauvegarder votre code dans un dépôt Git externe
+- Vous devriez aussi sauvegarder vos données dans un référentiel de données externe tel que S3
+- Vous pouvez facilement créer un nouveau service {{ .Chart.Name }}, cloner votre code et réinstaller les bibliothèques dont vous avez besoin.
+{{- end }}
+{{- else }}
 {{- if .Values.ingress.enabled }}
 - You can connect to this rstudio with your browser on this [link](http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }})
 {{- end }}
@@ -28,3 +60,4 @@ If you don't run your custom service you will get a 502 bad gateway error.
 - So, You should save your data to an external data repository like S3
 - You can easily create a new {{ .Chart.Name }} service, clone your code and install again some librairies you need
 {{- end }}
+{{- end }}
diff --git a/charts/rstudio/values.schema.json b/charts/rstudio/values.schema.json
@@ -753,19 +753,28 @@
             }
         },
         "userPreferences":{
-          "description": "User Preferences",
-          "type": "object",
-          "properties": {
-            "darkMode": {
-              "type": "boolean",
-              "description": "dark mode is or is not enabled",
-              "default": false,
-            "x-onyxia": {
-              "hidden": true,
-              "overwriteDefaultWith": "user.darkMode"
-              }
+            "description": "User Preferences",
+            "type": "object",
+            "properties": {
+                "darkMode": {
+                    "type": "boolean",
+                    "description": "dark mode is or is not enabled",
+                    "default": false,
+                    "x-onyxia": {
+                        "hidden": true,
+                        "overwriteDefaultWith": "user.darkMode"
+                    }
+                },
+                "language": {
+                    "type": "string",
+                    "description": "Preferred language",
+                    "default": "en",
+                    "x-onyxia": {
+                        "hidden": true,
+                        "overwriteDefaultWith": "user.lang"
+                    }
+                }
             }
-          }
         }
     }
 }
diff --git a/charts/rstudio/values.yaml b/charts/rstudio/values.yaml
@@ -181,3 +181,4 @@ repository:
 
 userPreferences:
   darkMode: false
+  language: "en"
diff --git a/charts/vscode-pyspark/Chart.yaml b/charts/vscode-pyspark/Chart.yaml
@@ -24,7 +24,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.3.10
+version: 1.3.11
 
 dependencies:
   - name: library-chart
Original file line number	Diff line number	Diff line change
Expand Up		@@ -238,3 +238,4 @@ startupProbe:

		userPreferences:
		darkMode: false
		language: "en"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -208,3 +208,4 @@ startupProbe:

		userPreferences:
		darkMode: false
		language: "en"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -221,3 +221,4 @@ repository:

		userPreferences:
		darkMode: false
		language: "en"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -181,3 +181,4 @@ repository:

		userPreferences:
		darkMode: false
		language: "en"