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]Flesh out complete documentation on how to extend Flytekit #834

Closed
kumare3 opened this issue Mar 16, 2021 · 4 comments
Closed

[Docs]Flesh out complete documentation on how to extend Flytekit #834

kumare3 opened this issue Mar 16, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation flytekit FlyteKit Python related issue

Comments

@kumare3
Copy link
Contributor

kumare3 commented Mar 16, 2021

Describe the documentation update
Flytekit can be extended in multiple ways

  • Type Extensions as somewhat explained here
  • SDK side task extensions, as somewhat explained here

Ideally this section should provide the user all the tools and links needed to extend flytekit for their needs.

An important note that should be emphasized is When to extend only flytekit - as documented here. There is actually a flowchart that explains when to extend flytekit.

A good example of writing a flytekit only plugin can be documented for SQLite3 plugin, which is a core plugin code here

An example usage for this task is available here

@kumare3 kumare3 added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers and removed untriaged This issues has not yet been looked at by the Maintainers labels Mar 16, 2021
@smariotti
Copy link

I'll be happy to have a look at this!

@SandraGH5
Copy link
Contributor

@samhita-alla @cosmicBboy Is this part of the current documentation revamp plan?

@cosmicBboy
Copy link
Contributor

we haven't specifically accounted for this issue yet in the docs revamp RFC, however it should be fairly straightforward to map it into the Extending Flyte section in the detailed hierarchy

This issue should ideally happen after docs have been re-structured by @samhita-alla

@SandraGH5 SandraGH5 added the flytekit FlyteKit Python related issue label Nov 17, 2021
@cosmicBboy cosmicBboy self-assigned this Dec 15, 2021
@cosmicBboy
Copy link
Contributor

Closing this as it's redundant with #1541.

This section in flytesnacks is the entrypoint for user guides relating to extending flyte.

eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 20, 2022
* Add example for resource overrides

Signed-off-by: Kevin Su <[email protected]>

Co-authored-by: SmritiSatyanV <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation flytekit FlyteKit Python related issue
Projects
None yet
Development

No branches or pull requests

4 participants