From 99bc41a621a2e392899c587f81cb9cbdfea6dc3f Mon Sep 17 00:00:00 2001 From: decentral1se Date: Sat, 21 Mar 2026 17:29:43 +0100 Subject: [PATCH] fix: wording, typos --- docs/maintainers/upgrade.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/maintainers/upgrade.md b/docs/maintainers/upgrade.md index 2fabd6c..85385ff 100644 --- a/docs/maintainers/upgrade.md +++ b/docs/maintainers/upgrade.md @@ -32,22 +32,24 @@ And in the [`abra.sh`](https://git.coopcloud.tech/coop-cloud/traefik/src/commit/ export TRAEFIK_YML_VERSION=v29 ``` -If you update teh `traefik.yml.tmpl` with new changes, you **must** increment +If you update the `traefik.yml.tmpl` with new changes, you **must** increment `TRAEFIK_YML_VERSION`. Otherwise, other Co-op Cloud operators will see an obscure error message when they try to deploy your new version. ## Backwards compatible environment variable changes -If you add a new environment variable to the `.env.sample` then you create -manual upgrade work for other Co-op Cloud operators. Depending on the -functionality that the environment variable enables or how the recipe is -already configured, it is possible to provide a default which maintains -backwards compatibility. There is hard and fast rule for this and it depends on -the recipe and context. +If you add a new environment variable to the `.env.sample` then you can +potentially create manual upgrade work for other Co-op Cloud operators. + +Depending on the functionality that the environment variable enables or how the +recipe is already configured, it is possible to provide a default which +maintains backwards compatibility. There is no hard and fast rule for this and it +depends on the recipe and context. A typical way to do this, is to provide a default in the `environment` stanza. -For example, providing a default of `false` for `NEW_ENV_VARS` so Co-op Cloud -operators do not need to set `NEW_ENV_VAR=false` in their app `.env` file. +For example, providing a default of `false` for a new fictitous environment +variable called `NEW_ENV_VAR` so other Co-op Cloud operators do not need to set +`NEW_ENV_VAR=false` in their app `.env` file (unless they want to change it). ```yaml environment: