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: update custom extractor tutorial #6703

Merged
merged 10 commits into from Oct 6, 2022
Merged

docs: update custom extractor tutorial #6703

merged 10 commits into from Oct 6, 2022

Conversation

jared-rimmer
Copy link
Contributor

I have ported over and merged content from:

https://meltano.com/blog/how-to-build-a-custom-extractor-with-meltano/

with the existing custom extractor tutorial in an attempt to making it a one stop shop for people wanting to get started with a creating a custom extractor.

Open questions

  • Terminology: I've used "custom extractor" throughout and changed references from tap, plugin, project, source. What are your thoughts on this?
  • SEO: As a lot of the content is a literal copy and paste from the blog it might have implications of duplicate content. Would you prefer a more thorough rewrite?

@netlify
Copy link

netlify bot commented Sep 2, 2022

👷 Deploy request for meltano pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 4e3b7f2

@codecov
Copy link

codecov bot commented Sep 2, 2022

Codecov Report

Merging #6703 (4e3b7f2) into main (7bbc90b) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #6703      +/-   ##
==========================================
+ Coverage   88.68%   88.70%   +0.01%     
==========================================
  Files         283      283              
  Lines       20401    20401              
  Branches     2010     2010              
==========================================
+ Hits        18093    18096       +3     
+ Misses       1971     1968       -3     
  Partials      337      337              
Impacted Files Coverage Δ
src/meltano/core/plugin_discovery_service.py 88.75% <0.00%> (-0.60%) ⬇️
src/meltano/core/plugin_location_remove.py 90.81% <0.00%> (+4.08%) ⬆️

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

@tayloramurphy
Copy link
Collaborator

@afolson you know more about SEO than me - what's our preference on this? cc @lauraperezco

@lauraperezco
Copy link
Contributor

@afolson you know more about SEO than me - what's our preference on this? cc @lauraperezco

@tayloramurphy same as the ELT page applies here, the main website has preference over subpages for SEO, so Jared's assesment is correct! I think ideally we should replace the current content in docs with a short introduction that takes you to the blog link for the full tutorial (and maybe reference some other blog-tutorials in the future to make this section in docs more complete while giving more authority to our website)

CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Edgar R. M. <edgarrm358@gmail.com>
@jared-rimmer
Copy link
Contributor Author

@lauraperezco happy to update with your suggestions 👍

From the Slack thread there was an aim to make the docs the place where users can find all this type of information. Linking out to blogs still achieves this

@emilylucie emilylucie self-requested a review September 6, 2022 16:55
@sbalnojan
Copy link
Contributor

sbalnojan commented Sep 9, 2022

Hey @jared-rimmer, no it's not necessary to update the page to include less. It can stay as you suggested, everything in once place.

But FWIW we're aware that we need to figure out a guide for what goes where, that's still WIP ;)

docs/src/_tutorials/custom-extractor.md Outdated Show resolved Hide resolved
docs/src/_tutorials/custom-extractor.md Outdated Show resolved Hide resolved
docs/src/_tutorials/custom-extractor.md Outdated Show resolved Hide resolved
docs/src/_tutorials/custom-extractor.md Outdated Show resolved Hide resolved
docs/src/_tutorials/custom-extractor.md Outdated Show resolved Hide resolved
jared-rimmer and others added 6 commits October 6, 2022 09:34
Co-authored-by: Edgar R. M. <edgarrm358@gmail.com>
Co-authored-by: Edgar R. M. <edgarrm358@gmail.com>
Co-authored-by: Edgar R. M. <edgarrm358@gmail.com>
Co-authored-by: Edgar R. M. <edgarrm358@gmail.com>
Co-authored-by: Edgar R. M. <edgarrm358@gmail.com>
Copy link
Contributor

@sbalnojan sbalnojan left a comment

Choose a reason for hiding this comment

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

all changes adressed!

@sbalnojan sbalnojan dismissed edgarrmondragon’s stale review October 6, 2022 09:10

PR creator addressed all changes.

@sbalnojan sbalnojan merged commit 13d1ee7 into meltano:main Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants