flancian/docs.coopcloud.tech
0
0
Fork 0
forked from toolshed/docs.coopcloud.tech
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document naming convention

Browse Source 
See toolshed/organising#680
This commit is contained in:
decentral1se
2025-11-04 15:07:12 +01:00
parent d99a13d4fa
commit 017cc9b38d
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/maintainers/handbook.md
View File

@ -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