From 2764a96353ee5b2affc741be954c3c5808b07cfe Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Wed, 5 Jun 2024 20:38:27 +0200 Subject: [PATCH] docs: add lifecycle paragraph in the dev docs --- docs/services/general-info/envvar-scopes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/services/general-info/envvar-scopes.md b/docs/services/general-info/envvar-scopes.md index 470851066..289a36072 100644 --- a/docs/services/general-info/envvar-scopes.md +++ b/docs/services/general-info/envvar-scopes.md @@ -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.