[docs-only] update env_vars.yaml post Activitylog API merge #9466
Conversation
|
CI hangs, no PR issue |
| when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes | ||
| are used is dependent on the library of the configured store. See the Environment | ||
| Variable Types description for more details. | ||
| introductionVersion: pre5.0 |
There was a problem hiding this comment.
These are "interesting", changing from "5.0" to "pre5.0"
| type: bool | ||
| description: 'Allow credentials for CORS.See following chapter for more details: | ||
| *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' | ||
| introductionVersion: pre5.0 |
There was a problem hiding this comment.
Maybe I do not understand the process.
How can these new lines have introductionVersion: pre5.0 ?
There was a problem hiding this comment.
The process is the following:
make -C docs docs-generate parses all the envvars from all services and adds them to a kind of "database" file (this one) for further actions + another file that has no change in this PR. We need both to generate the final .adoc files. The helper takes whatever devs have done with envvars in services, therefore the helper is "neutral" about the content. To distinguish when an envvar has been added, we needed to decide which one have been introduced before 5.0. Having that, we can now clearly identify when an envvar has been introduced, respctively will get added where the release is currently not known (%%NEXT%%) or deprecated.
With an upcoming version of the helper, we will add to the adoc output WHEN the respective envvar got introduced in the admin docs. Also, we can now provide easily a list of introduced envvars for a particular release 😄
Also see the Docs Helpers description for more details.
Hope this makes sense.
|
please rebase |
mmattel
force-pushed
the
fixes_docs_helper_output
branch
from
ad1ec72
to
91f5903
Compare
|
@micbar rebase done + commit with updates containing the latest changes 😃 |
|
[docs-only] update env_vars.yaml post Activitylog API merge
References: #9361 (Activity API)
After #9361 was merged, we need to update the helper yaml file to show correct values in docs.