<#8600 docs: Improve reference description of `set...
# meltano-repo-activity
g
#8600 docs: Improve reference description of
settings[*].aliases
and
settings[*].env
Issue created by ReubenFrankel The documentation around these two settings is a bit confusing. See https://meltano.slack.com/archives/C068YBV6KEK/p1719398735756859 for some context. --- ###
aliases
From https://docs.meltano.com/reference/plugin-definition-syntax/#settingsaliases
Optional. An array of aliases for the setting.
This is a bit vague. How does a user know what an alias is? The
meltano.yml
JSON schema description of this setting is a little more detailed, but doesn't specify whether I can provide config via an environment variable with respect to an alias (you can in the form of
TAP_BIGQUERY_<alias>
, but not from an arbitrary environment variable): meltano/src/meltano/schemas/meltano.schema.json Line 784 in</meltano/meltano/commit/9463a022aa1f1e08c489417e72c7bc5f78d10739|9463a02> | "description": "Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'", | | ------------------------------------------------------------------------------------------------------ | ###
env
From https://docs.meltano.com/reference/plugin-definition-syntax/#settingsenv
Use to delegate to an environment variable for overriding this setting's value.
This is actual what
aliases
should be used for, right? The JSON schema description of this setting is correct I think: meltano/src/meltano/schemas/meltano.schema.json Line 870 in</meltano/meltano/commit/9463a022aa1f1e08c489417e72c7bc5f78d10739|9463a02> | "description": "An alternative environment variable name to populate with this settings value in the plugin environment.", | | -------------------------------------------------------------------------------------------------------------------------- | meltano/meltano