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 meltano.yml vs meltano config or env #7765

Merged
merged 7 commits into from
Jun 9, 2023

Conversation

mjsqu
Copy link
Contributor

@mjsqu mjsqu commented Jun 8, 2023

No description provided.

@mjsqu mjsqu requested review from sbalnojan, tayloramurphy and a team as code owners June 8, 2023 22:34
@netlify
Copy link

netlify bot commented Jun 8, 2023

Deploy Preview for meltano ready!

Name Link
🔨 Latest commit b0862c9
🔍 Latest deploy log https://app.netlify.com/sites/meltano/deploys/64828e6bf5b41b0008ae50f8
😎 Deploy Preview https://deploy-preview-7765--meltano.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@mjsqu
Copy link
Contributor Author

mjsqu commented Jun 8, 2023

Change made for all blocks matching a pattern, putting this here in case I need to reuse it:

Manage this extra directly in your \[`meltano.yml` project file\]\(project#meltano-yml-project-file\):((?:.|\n)+?)Alternatively.*((?:.|\n)+?)^```$


Manage this extra:\n{% tabs cli %}\n{% tab cli meltano.yml %}$1{% endtab %}\n{% tab cli config %}$2{% endtab %}\n{% endtabs %}

Copy link
Member

@WillDaSilva WillDaSilva left a comment

Choose a reason for hiding this comment

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

Thanks @mjsqu!

Could you please split the "CONFIG" tab into a "CLI" and "ENV VAR" tab?

docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
docs/src/_concepts/plugins.md Outdated Show resolved Hide resolved
@tayloramurphy
Copy link
Collaborator

tayloramurphy commented Jun 9, 2023

@sbalnojan what do you think of this change? I like it as it brings the focus to the YAML file. https://deploy-preview-7765--meltano.netlify.app/concepts/plugins#state-extra for example

@mjsqu
Copy link
Contributor Author

mjsqu commented Jun 9, 2023

Just updated to add @WillDaSilva suggestion of splitting out 'env' into another tab. Also aligned all tab groups with the name extra_usage so they should all shift at once throughout the page

@tayloramurphy
Copy link
Collaborator

@mjsqu I quite like that! I'm going to hit merge :shipit:

@tayloramurphy tayloramurphy merged commit 1a3c718 into meltano:main Jun 9, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants