Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Use tabs for examples on settings page #8201

Merged
merged 8 commits into from
Oct 3, 2023

Conversation

mjsqu
Copy link
Contributor

@mjsqu mjsqu commented Sep 30, 2023

Updates the Settings page in line with my previous change (#7765) for the Plugins page, adding tabs.

Settings examples are split by the following where appropriate:

  • meltano init
  • meltano config
  • export (environment variable)
  • meltano command switch

The CSS change is the difference between a tab header being rendered like this:

meltano
config

and

meltano config

I'm not entirely sure the correct wording for tab headers, so if a more concise word is used, the CSS update could be reverted - I'm unsure if I edited the correct spot in the CSS - and didn't assess where else it might have had an impact.

Settings are split by the following where appropriate:

- meltano init
- meltano config
- export (environment variable)
- meltano command
@netlify
Copy link

netlify bot commented Sep 30, 2023

Deploy Preview for meltano canceled.

Name Link
🔨 Latest commit 3dcb553
🔍 Latest deploy log https://app.netlify.com/sites/meltano/deploys/651c2356f48d630007fae056

E.g. if you click on 'env' all tabs on the page shift to 'env' - helpful
if you have chosen one config style and want to stick to it for all
settings/config
@mjsqu
Copy link
Contributor Author

mjsqu commented Sep 30, 2023

A couple of (optional) extras:

Copy link
Collaborator

@tayloramurphy tayloramurphy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this change! @cjohnhanson or @leoroese would either of you mind reviewing the CSS?

@tayloramurphy
Copy link
Collaborator

@mjsqu I'm fine with the color as-is. I like the idea of the querystring param change though. Feel free to add that 👍 thanks for the PR!

@edgarrmondragon edgarrmondragon changed the title docs: tabs for examples on Settings page docs: Use tabs for examples on settings page Oct 2, 2023
@edgarrmondragon edgarrmondragon added Documentation Improvements or additions to documentation Community-Contributed PR labels Oct 3, 2023
@edgarrmondragon
Copy link
Collaborator

@mjsqu I'm fine with the color as-is. I like the idea of the querystring param change though. Feel free to add that 👍 thanks for the PR!

@tayloramurphy That's already done, with the meltano-tabs query param and I confirmed it works. I think this is g2g.

@tayloramurphy tayloramurphy added this pull request to the merge queue Oct 3, 2023
Merged via the queue into meltano:main with commit 4dcafc2 Oct 3, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community-Contributed PR Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants