owncloud / owncloud/ocis

Deprecation table (adoc) for Global envvars

Open
#6,028 5 comments 0 reactions 0 assignees View on GitHub
Category:Enhancement
Dominant language
Go
Stars
2.1k
Forks
274
Avg merge
2d 1h
Merged PRs (30d)
103

Description

What we have und successfully use:

1. Automatically create per service an adoc page with a table for envvars
2. Fill and enable the deprecation table above this table if a deprecation exists (per service)
3. Generate an own adoc page with a table for global envvars

Info:
* To generate the global envvar table, we parse to each service and remember the envvar. If the same envvar appears in another service, it is added to the global adoc table.
* If there is a deprecation, this looks like this, note that the replacement can be empty if an envvar is phased out:
**local**: `env:"OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES;USERLOG_STORE_ADDRESSES"`
`...deprecationReplacement:"USERLOG_STORE_NODES`
**global**: `env:"OCIS_LDAP_USER_FILTER;LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER"`
`...deprecationReplacement:"OCIS_LDAP_USER_FILTER"`

**Here is the request, we need some changes:**

* When the global envvar table is created and there is a deprecation for a global envvar, we need in the same cell both, the new and the deprecated envvar.
Note that the active global envvar is on the first position in the definition, therefore this envvar must be listed first.
* Then, as we do with standard deprecations in services, we add a xref: in the cell to point to the deprecation table on top.
* And finally, we create a global deprecation table on top similar as we do with services.

@dragonchaser @kobergj @2403905

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.