feat(gridsome): Add more details to settings section

[rwfeather]

Right now we are still missing a few things from old hub:

• Environment variable form
• Default value
• "How to Use" section

[tayloramurphy]

target-redshift is a good example to review as well https://github.com/meltano/hub/blob/main/_data/meltano/loaders/target-redshift/transferwise.yml https://hub.meltano.com/loaders/target-redshift

Confirming key things to display:

• environment variable form <plugin_name>_<setting_name>
• default value
• description (in YAML file)
• How to use section can be autogenerated based on the setting name and either the default or the kind (integer, password, etc.)

Note that target-redshift has the options type as well https://github.com/meltano/hub/blob/main/_data/meltano/loaders/target-redshift/transferwise.yml#L222 but it currently renders odd on classic hub.

[tayloramurphy]

How to use section can be autogenerated based on the setting name and either the default or the kind (integer, password, etc.)

From #663 - I'm not sold that we shouldn't have this section as-is, but currently there are no instructions on the preview. I'm fine with either recreating what we have or having instructions on setting with --interactive, but we need to have something. We can take another post-launch iteration on what we want there for each setting. @aaronsteers @rwfeather does that work?

[aaronsteers]

@tayloramurphy - How about a simple "Configuration" header after settings list, with instructions for --interactive as per the below:

Settings

The dbt-postgres settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

project_dir ... sslmode

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file.

Configuration

All of the below settings can be configured by running meltano config set {plugin_name} --interactive. For more ways to configure, see meltano config.

[...Dynamic settings list here...]

But instead of {plugin_name}, it would be the actual plugin name.

I can mock this up real quick if this works for you.

[aaronsteers]

@tayloramurphy - A small alteration on the paragraph above could be:

All plugin settings can be configured by running meltano config set {plugin_name} --interactive. Advanced users can also set these values using environment variables.

This gives users a clear and simple suggestion to use --interactive, while also sending them to the appropriate pages to learn more if they want to do it another way. While env var - based config is a critical feature for advanced users, I don't really want to be promoting env variables in the Hub because it leads to confusion in the new-user experience, when we want users to have a clear "golden path" without unnecessary distractions or hurdles.

What do you think?

[tayloramurphy]

@aaronsteers love that suggestion and it works for me 👍