From 017cc9b38ddbc538f15286951365bdd4a4b3c14d Mon Sep 17 00:00:00 2001 From: decentral1se Date: Tue, 4 Nov 2025 15:07:12 +0100 Subject: [PATCH] docs: document naming convention See https://git.coopcloud.tech/toolshed/organising/issues/680 --- docs/maintainers/handbook.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/maintainers/handbook.md b/docs/maintainers/handbook.md index 66ef2e4c..07e15a07 100644 --- a/docs/maintainers/handbook.md +++ b/docs/maintainers/handbook.md @@ -86,6 +86,16 @@ Because configurations are maintained in-repository by maintainers, we version t export NGINX_CONFIG_VERSION=v1 ``` +!!! warning + + It is **very important** that the naming convention of the config matches + the whole way down. In the above example, that is `nginx_config` in the + `configs:` stanza, `nginx_config` in `name: + ${STACK_NAME}_nginx_config_${NGINX_CONFIG_VERSION}` and finally + `NGINX_CONFIG_VERSION` in the `abra.sh`. This is the naming convention that + `abra` will perform to carry out the lookup of all matching names/values. + See [`#693`](https://git.coopcloud.tech/toolshed/abra/issues/693) for more. + ## Manage environment variables !!! warning