-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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][guide] writing a multi-asset backed integration #22910
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
0533f7b
to
b286464
Compare
11e40ac
to
07622a6
Compare
11fdb33
to
950746f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this content looks really great!
I have 2 thoughts:
- Might make sense to add a sentence (or a short code snippet) explicitly explaining that asset dependencies will still work (and why)
- We might want to link this blogpost (what a coincidence!) which explains how to go further into more advanced asset customization (like providing common data transformations on library side). The tutorial suggests creating a resource to handle common logic, and this is an alternative approach. It might be slightly more convenient because the user doesn't need to call the resource. I don't know how often is something like this needed, just a suggestion.
- Should the tutorial also provide an example of writing an
IOManager
to handle common IO instead doing it in aResource
? Or perhaps just link toIOManager
docs?
07622a6
to
8da012a
Compare
Thanks for the feedback, @danielgafni. I've included a link to your blog post - what a coincidence indeed! And made it more explicit in that dependencies can be defined. I'm going to hold off on I/O managers for now as we don't do that for the Sling or dlt integration. Edit: I've also included links in the side menu. |
950746f
to
6561292
Compare
49e0912
to
0f9c772
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Back to you!
docs/content/guides/integrations/approaches-to-writing-integrations.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Outdated
Show resolved
Hide resolved
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Show resolved
Hide resolved
Thanks again for your feedback, @erinkcochran87 , I believe I have addressed it all. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left comments around IA/navigation. overall looking good - we may be able to simplify the metadata threading, but i think we can land this and iterate.
- An understanding of Python decorators — [Real Python's Primer on Python Decorators](https://realpython.com/primer-on-python-decorators/) is a fantastic introduction | ||
|
||
--- | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
feel free to push back, and we can address it in the jobs-to-be-done world
i wonder if we could add a "when to model your integration in this way" section, where we can explain the whys (e.g. composability), map pattern to category like "ETL", "BI" and also list example implementations like you did on the "Approaches to writing integrations"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do like that idea - however, let's see if we can merge this first, and then make improvements.
Much of this may be rewritten or scrapped as a part of the docs overhaul. If we can merge this, then we can consider restructuring in the docathon if that works for you.
docs/content/guides/integrations/writing-a-multi-asset-decorator-integration.mdx
Show resolved
Hide resolved
…r and translator can be customized
…tions.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
…or-integration.mdx Co-authored-by: Erin Cochran <[email protected]>
6a64f16
to
5dde31a
Compare
NOTE: Once content has been reviewed, I can refactor the snippets to
docs_snippets
for proper linting.