From e679c01dfcdd70d392ed5f91c57677400f2e5447 Mon Sep 17 00:00:00 2001 From: Martin Date: Fri, 23 Aug 2024 08:44:46 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Phil Davis --- docs/ocis/development/envvars.md | 4 ++-- docs/services/general-info/deprecating-variables.md | 8 ++++---- docs/services/general-info/envvar-scopes.md | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/ocis/development/envvars.md b/docs/ocis/development/envvars.md index 4e7e317438..c401b370d8 100644 --- a/docs/ocis/development/envvars.md +++ b/docs/ocis/development/envvars.md @@ -7,7 +7,7 @@ geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: envvars.md --- -Environment variables are an essential part configuring services. +Environment variables are an essential part of configuring services. -If you are going to create new ones or deprecate existing ones, mandatory read the [Envvar Naming Scope]({{< ref "services/general-info/envvar-scopes.md" >}}) and the +If you are going to create new ones or deprecate existing ones, you must read the [Envvar Naming Scope]({{< ref "services/general-info/envvar-scopes.md" >}}) and the [Deprecating Variables]({{< ref "services/general-info/deprecating-variables.md" >}}) documentation for more details first before doing so. diff --git a/docs/services/general-info/deprecating-variables.md b/docs/services/general-info/deprecating-variables.md index eff2f312f4..bc77eebe9f 100644 --- a/docs/services/general-info/deprecating-variables.md +++ b/docs/services/general-info/deprecating-variables.md @@ -11,7 +11,7 @@ geekdocFilePath: deprecating-variables.md ## Deprecating Environment Variables -Sometimes it is necessary to deprecate an environment variable to align the naming with conventions or remove it at all. We therefore added annotations to automate the *documentation* process. +Sometimes it is necessary to deprecate an environment variable to align the naming with conventions or remove it completely. We therefore added annotations to automate the *documentation* process. The relevant annotations in the envvar struct tag are: @@ -20,15 +20,15 @@ The relevant annotations in the envvar struct tag are: * `removalVersion`\ The version it is finally going to be removed is defined via the mandatory placeholder `%%NEXT_PRODUCTION_VERSION%%`, not an actual version number. * `deprecationInfo`\ - The reason why it got deprecated. + The reason why it was deprecated. * `deprecationReplacement`\ Only if it is going to be replaced, not necessary if removed. {{< hint warning >}} -During the development cycle, the value for the `removalVersion` must be set to `%%NEXT_PRODUCTION_VERSION%%`. This placeholder will be removed by the real version number during the production releasing process. +During the development cycle, the value for the `removalVersion` must be set to `%%NEXT_PRODUCTION_VERSION%%`. This placeholder will be replaced by the real version number during the production releasing process. {{< /hint >}} -For the documentation only to show the correct value for the `removalVersion`, our docs helper scripts will automatically generate the correct version to be printed in the documentation. If `%%NEXT_PRODUCTION_VERSION%%` is found in the query, it will be replaced with `next-prod`, else the value found is used. +For the documentation to show the correct value for the `removalVersion`, our docs helper scripts will automatically generate the correct version to be printed in the documentation. If `%%NEXT_PRODUCTION_VERSION%%` is found in the query, it will be replaced with `next-prod`, else the value found is used. ### Example diff --git a/docs/services/general-info/envvar-scopes.md b/docs/services/general-info/envvar-scopes.md index 3c9068867e..f043cf36d9 100644 --- a/docs/services/general-info/envvar-scopes.md +++ b/docs/services/general-info/envvar-scopes.md @@ -54,13 +54,13 @@ If a new envvar is introduced, only the `introductionVersion` is required. During the development cycle, the value for the `introductionVersion` must be set to `%%NEXT%%`. This placeholder will be removed by the real version number during the production releasing process. {{< /hint >}} -For the documentation only to show the correct value for the `IV` (introduction version), our docs helper scripts will automatically generate the correct version to be printed in the documentation. If `%%NEXT%%` is found in the query, it will be replaced with `next`, else the value found is used. +For the documentation to show the correct value for the `IV` (introduction version), our docs helper scripts will automatically generate the correct version to be printed in the documentation. If `%%NEXT%%` is found in the query, it will be replaced with `next`, else the value found is used. During the releasing process for a production release, the placeholder `%%NEXT%%` has to be replaced with the new production version number like `%%NEXT%%` → `7.0.0`. ### Deprecate Existing Envvars -See the [deprecation rules]({{< ref "./deprecating-variables.md" >}}) documentation fo rmore details. +See the [deprecation rules]({{< ref "./deprecating-variables.md" >}}) documentation for more details. ## Separating Multiple Envvars