mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-30 17:00:57 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: add lifecycle paragraph in the dev docs

Browse Source
This commit is contained in:
Michael Barz
2024-06-05 20:38:27 +02:00
parent efe4895a98
commit 2764a96353
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/services/general-info/envvar-scopes.md
View File

@@ -34,6 +34,10 @@ Note that this envvar is the global representation of the local example from abo
To get a list of global envvars used in all services, see the [Global Environment Variables](https://doc.owncloud.com/ocis/next/deployment/services/env-vars-special-scope.html#global-environment-variables) table in the ocis admin documentation.
### Lifecycle
In the struct tag values of our config data types, we are using three key/value pairs to document the lifecycle of a config variable: `introductionVersion`, `deprecationVersion` and `removalVersion`. During the development cycle, a new value should set to `%%NEXT%%` as long as no release is scheduled. During the release process, the palceholder will be replaced with the actual version number. Our docs helper scripts will then automatically generate the correct documentation based on the version number.
## Deprecations
All environment variable types that are used in a service follow the same [deprecation rules]({{< ref "ocis/development/deprecating-variables/_index.md" >}}) independent of their scope.