From a302961218b8dd17039c2eb9c3ecc650373f9589 Mon Sep 17 00:00:00 2001 From: Joseph Garrone Date: Fri, 22 Sep 2023 22:37:34 +0200 Subject: [PATCH] Improve helm chart readme --- helm-chart/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/helm-chart/README.md b/helm-chart/README.md index de3be0b33..8cec821d6 100644 --- a/helm-chart/README.md +++ b/helm-chart/README.md @@ -17,15 +17,16 @@ helm install onyxia onyxia/onyxia --version "4.0.1" -f onyxia-values.yaml Complete installation guide: https://onyxia.sh/ -## Parameters documentation +## Parameter Documentation -- `api` parameters: [../api/README.md](https://github.com/InseeFrLab/onyxia-api/blob/v0.30/README.md#configuration) -- `web` parameters: [../.env](../.env) +- [`api` Parameters](https://github.com/InseeFrLab/onyxia-api/blob/v0.30/README.md#configuration) +- [`web` Parameters](https://github.com/InseeFrLab/onyxia/blob/v2.29.4/.env) -This is a little sample of a typical `onyxia-values.yaml` to show where -the parameters of onyxia-web and onyxia-api should be filled in: +> **Note:** The links above are automatically updated to always point to the relevant documentation for the current version of the Onyxia Helm Chart. -`onyxia-values.yaml` +Below is a sample `onyxia-values.yaml` file that illustrates where to specify the `api` and `web`. + +### Sample `onyxia-values.yaml` ```diff ingress: