Loading...

XML

Word

Printable

Story Points:
2
Blocked:
False
Blocked Reason:

Hide

None

Show
None
Ready:
False
Epic Link:
Improve Dynamic Plugins Configuration guide
Release Note Text:

Hide
Before this update, most of the plugins are missing information about required and optional environment variable in the {product-short} documentation.

With this update, the {product-short} plugins documentation contains information about required and optional environment variable.

Show
Before this update, most of the plugins are missing information about required and optional environment variable in the {product-short} documentation. With this update, the {product-short} plugins documentation contains information about required and optional environment variable.
Release Note Type:
Enhancement
Release Note Status:
Rejected
Intelligence Requested:
Market:

Most of the plugins are missing information about required/optional env variable in the following documentation:

Good example is Nexus Repository Manager which is missing information about following env variables (without the plugin does not function correctly):

extraEnvVars:

name: NEXUS_REPOSITORY_MANAGER_URL
value: "https://$DOCKER_REGISTRY" //substitute with real value, https:// is required!
name: NEXUS_REPOSITORY_MANAGER_SECURE
value: "false"

The documentation further lacks the updates required for catalog-info.yaml - as described here: https://github.com/janus-idp/backstage-plugins/blob/main/plugins/nexus-repository-manager/ANNOTATIONS.md
Without catalog-info.yaml updates, the component does not active the Nexus plugin.

Acceptance criteria:
Documentation will include exhaustive information about usage and configuration of every single dynamic plugin.