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]flytekit plugin docs improvements in flytesnacks #1541

Closed
3 of 6 tasks
kumare3 opened this issue Oct 1, 2021 · 8 comments
Closed
3 of 6 tasks

[Docs]flytekit plugin docs improvements in flytesnacks #1541

kumare3 opened this issue Oct 1, 2021 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation plugins Plugins related labels (backend or frontend)
Milestone

Comments

@kumare3
Copy link
Contributor

kumare3 commented Oct 1, 2021

Describe the documentation update
Flytesnacks should have an updated documentation for how to author flytekit plugins

@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 Oct 1, 2021
@kumare3 kumare3 added this to the 0.18.1 milestone Oct 1, 2021
@samhita-alla samhita-alla self-assigned this Oct 1, 2021
@EngHabu EngHabu modified the milestones: 0.18.1, 0.18.2 Nov 3, 2021
@SandraGH5 SandraGH5 added the plugins Plugins related labels (backend or frontend) label Nov 18, 2021
@EngHabu
Copy link
Contributor

EngHabu commented Dec 1, 2021

@samhita-alla is this planned for December? maybe as part of the doc-push?

@EngHabu EngHabu modified the milestones: 0.18.2, 0.19.0 - Eagle Dec 1, 2021
@samhita-alla
Copy link
Contributor

@samhita-alla is this planned for December? maybe as part of the doc-push?

Oh yeah. That sounds good.

@samhita-alla samhita-alla removed their assignment Dec 29, 2021
@samhita-alla
Copy link
Contributor

samhita-alla commented Dec 30, 2021

This issue is partly covered in #834.

@cosmicBboy, if taking up the above-mentioned issue, which ones would you likely be working on in the given list?

@cosmicBboy
Copy link
Contributor

cosmicBboy commented Jan 3, 2022

Hey @samhita-alla I think some of the problems articulated in #834 have been addressed in this section:
https://docs.flyte.org/projects/cookbook/en/latest/auto/core/extend_flyte/index.html

I think the bullet points above

SQL plugins
flytekit only plugins
flytekit template plugins
flytekit shim plugins for backend plugins
Type plugins
Data persistence plugins

Can be new pages under the "Extending Flyte" page in flytesnacks.

@kumare3 can you clarify the difference between "flytekit only plugins" and "flytekit template plugins?" Just because I think:

  • this page already takes care of "Type plugins"
  • this page takes care of "flytekit only plugins"

FYI there are these pages in the flytekit API reference:

But I think those should basically be a function/class API reference while the new pages under flytesnacks are for user education (and should link to appropriate functions/class in the API reference via intersphinx)

I'm going to close #834. Let me know if you need any help with any of these pages!

update

@cosmicBboy cosmicBboy changed the title [Docs]flytekit plugin docs improvements [Docs]flytekit plugin docs improvements in flytesnacks Mar 10, 2022
@cosmicBboy cosmicBboy added plugins Plugins related labels (backend or frontend) and removed plugins Plugins related labels (backend or frontend) labels Apr 21, 2022
@EngHabu EngHabu modified the milestones: 1.0.0 - Phoenix!, 1.0.1 May 20, 2022
@cosmicBboy
Copy link
Contributor

fixes flyteorg/flytesnacks#744

@cosmicBboy
Copy link
Contributor

@cosmicBboy cosmicBboy reopened this Jul 7, 2022
@cosmicBboy
Copy link
Contributor

Will close this issue when flyteorg/flytesnacks#744 is merged

@samhita-alla
Copy link
Contributor

merged flyteorg/flytesnacks#744

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 plugins Plugins related labels (backend or frontend)
Projects
None yet
Development

No branches or pull requests

8 participants