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: Add DataHub HowTo #6709

Merged
merged 6 commits into from Sep 22, 2022
Merged

docs: Add DataHub HowTo #6709

merged 6 commits into from Sep 22, 2022

Conversation

sbalnojan
Copy link
Contributor

Added a how for the data hub utility.

@netlify
Copy link

netlify bot commented Sep 6, 2022

Deploy Preview for meltano ready!

Name Link
🔨 Latest commit fad84c3
🔍 Latest deploy log https://app.netlify.com/sites/meltano/deploys/632bfa5b2d0eb1000cac16c0
😎 Deploy Preview https://deploy-preview-6709--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.

@sbalnojan sbalnojan changed the title Add DataHub HowTo docs: Add DataHub HowTo Sep 6, 2022
@codecov
Copy link

codecov bot commented Sep 6, 2022

Codecov Report

Merging #6709 (e7310ad) into main (5c81e0a) will decrease coverage by 0.05%.
The diff coverage is n/a.

❗ Current head e7310ad differs from pull request most recent head fad84c3. Consider uploading reports for the commit fad84c3 to get more accurate results

@@            Coverage Diff             @@
##             main    #6709      +/-   ##
==========================================
- Coverage   88.60%   88.55%   -0.06%     
==========================================
  Files         280      280              
  Lines       20260    20226      -34     
  Branches     2002     2002              
==========================================
- Hits        17952    17911      -41     
- Misses       1972     1979       +7     
  Partials      336      336              
Impacted Files Coverage Δ
src/meltano/core/schedule_service.py 88.65% <0.00%> (-3.80%) ⬇️
src/meltano/core/error.py 83.33% <0.00%> (-2.78%) ⬇️
src/meltano/core/project_plugins_service.py 89.83% <0.00%> (-1.61%) ⬇️
src/meltano/cli/utils.py 81.59% <0.00%> (-1.05%) ⬇️
tests/meltano/core/test_schedule_service.py 93.16% <0.00%> (-0.29%) ⬇️
tests/meltano/core/test_environment_variables.py 96.51% <0.00%> (-0.20%) ⬇️
src/meltano/core/utils/__init__.py 89.44% <0.00%> (-0.05%) ⬇️
src/meltano/api/app.py 87.35% <0.00%> (ø)
tests/meltano/cli/test_cli.py 100.00% <0.00%> (ø)
src/meltano/core/settings_store.py 94.61% <0.00%> (+0.04%) ⬆️
... and 1 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@tayloramurphy
Copy link
Collaborator

@sbalnojan I like the content of this, but I'm not sure it's right for the Meltano Docs. I think this either needs to be a blog post or a Tutorial. Having it in the Guide section puts an overemphasis on DataHub in particular when compared to the ELT functionality.

Some of the could also live in https://hub.meltano.com/utilities/datahub but likely we should link from the Hub to where this doc winds up living.

@afolson your thoughts on this?

@sbalnojan
Copy link
Contributor Author

@tayloramurphy mh you think? I mean I agree, we shouldn't overemphasize one plugin, but that just means, we definitely need way more How Tos and not just this one.

DataHub is a great complement to ELT (as is Great Expectations), and I think it would be really helpful to have all the information in one place (the docs).

Do you really want to redirect someone to some other place to answer the simple "how do I use DataHub with Meltano" question?

But, I would like to propose a restructuring anyways, putting this and 1-2 more pieces into a dedicated "How To" section (specific answers to specific problems while I'm working it). And restructure the "Guides" section into a Tutorial + Getting Started Section. I just thought that belongs into a separate PR.

@tayloramurphy
Copy link
Collaborator

@sbalnojan fair points. I do think the overall information architecture of the docs could take another iteration. My main point is that I don't think it's right for the current guide section and it seems like "Tutorials" would be better.

But, I would like to propose a restructuring anyways, putting this and 1-2 more pieces into a dedicated "How To" section (specific answers to specific problems while I'm working it). And restructure the "Guides" section into a Tutorial + Getting Started Section. I just thought that belongs into a separate PR.

I like that and I wouldn't be opposed to having that PR come in first, but that's primarily because of the pain of having to redirect if/when the URL changes.

My recommendation would either to update this PR to move the new content to Tutorials and then have the new PR update the structure or vice versa and wait to get this merged.

@sbalnojan
Copy link
Contributor Author

@tayloramurphy I forgot to tag you @tayloramurphy and I feel like all conversations have been resolved.

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.

Great iteration - let's ship it and add more! 😄

@sbalnojan sbalnojan merged commit 2193514 into main Sep 22, 2022
@sbalnojan sbalnojan deleted the 634-add-how-to-datahub branch September 22, 2022 06:08
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

2 participants