Flyte Hacktoberfest 2024: issues and guidelines

[davidmirror-ops]

Describe the issue

Hello hello 👋!

It's that time of year again! We're excited to kick off Hacktoberfest and get you started on your open-source contributions.

This page covers all the issues and contribution guidelines to help you get started with Flyte and Hacktoberfest!

Resources

• Contribution guide
• Questions? Go to the #hacktoberfest-2024 channel

Guidelines

• Before working on an issue, ask questions and make sure you understand the problem and how to fix it. Then, add a comment on the issue requesting to be assigned or leave a comment with #take.
• On the PR, use one of the Github-supported keywords to link it back to the issue.
• After a first review, the PR will get the hacktobertfest-accepted label and we expect you to apply feedback and shepherd your contribution until it's merged.
• If the issue is assigned to you, but someone else sends a valid PR before you do, we'll ask and wait for 2 days to get your PR. Otherwise, the first PR will be accepted.

Prizes

To thank you for your contributions, we have prizes! From exclusive Flyte t-shirts and stickers to cozy sweatshirts, and a pair of the new AirPods Pro 2 for those big contributions (including new integrations/plugins). Every contribution registered in the form will receive a prize, the more contributions you make, and the more significant the contribution, the greater the prize.

Fill out this form to register your merged PRs or content contributions on or before Oct. 31, 2024.

---

Content contributions

If you're here, you're probably at the same time learning Flyte and trying to improve the codebase, which is hard.
You can split the effort and increase your chances of earning well-deserved swag:

• Write a blog post teaching something you learned about Flyte. Examples include: how to install Flyte, how to use a particular plugin/agent, how to fix a common problem, etc.

• Record a demo showcasing something you learned about Flyte.

In any of these cases, let us know in the #hacktoberfest-2024 channel or by commenting here where you post/plan to post the content and we'll review it. Once reviewed and accepted, swag will be yours.

---

Code and Documentation Contribution opportunities

This year we wanted to focus on the many aspects of the Flyte documentation and examples that can be improved.

The following is a detailed breakdown of all the available issues against the repository they relate to:

Repo	Scope	Tech stack	Section
Flytekit	Python SDK & Integrations	Python	Flytekit
Flytesnacks	Examples	Python, Sphinx	Flytesnacks
Flyte	Backend, documentation, console	Golang, Markdown , reStructuredText	Flyte

Flytesnacks

Contribution Guide

• [Docs] Ray plugin documentation missing details #5738
• [Docs] fix feast jupyter notebook #4455
• [Docs] pydantic integration: create flytesnacks example page #4066
• [Docs] tensorflow types: create flytesnacks example page #4065
• [Docs] Clarify what Resource is used when doing FlyteFile/Directory.download() or current_context().working_dir #3516
• [Docs] Add gate node example for dynamic workflows #3448
• [Docs] Create model deployment and data annotation-specific examples for gate nodes #3447
• [Docs] vaex integration: create flytesnacks example page #3285
• [Docs] document the process of rendering a notebooktask in a flyte deck #4463
• Add native visualization with FlyteDecks to the Great Expectations integration #4194
• [Plugin]: Add example of per model dbt execution #3135
• [Docs] Yellowbrick and Cleanlab visualizations in FlyteDeck #3084

Flyte

Contribution guide

• [Docs] docs for IAM, service accounts, labels and annotations #1512
• [Docs] Update logging links documentation for Cloudwatch #5760
• [Docs] Improve registration patterns docs #5669
• [Docs] auth setup page issues #5552
• Add Array Node Index To current_context [Core feature]  #5534
• [Docs] Help messages, error messages, and documentation for pyflyte package unfortunately result in a very bad first-time UX #5435
• [Docs] Document supported authType values #5021
• [Docs] Struggling to get Keycloak working as external authorization server #4955
• [BUG] Flytescheduler cron expression validation process #4953
• [Docs] Provide documentation on where blob storage is accessed and which keys are being used #4881
• [Docs] Document logging inside Python tasks running on a remote cluster #4830
• [Docs] Some P0 tests are broken #4764
• [Docs] document ci/cd best practices #4685
• [Docs] document that execution IDs are unique within a project-domain #4684
• [Docs] document clarifying notes about the data lifecycle #4683
• [Docs] document resolution for forbidden error when accessing dask resources #4653
• [Docs] Docstring for map_task's min_success_ratio #4623
• [Docs] modify the registration flow graphic to have a white background #4614
• [Docs] document the pyflyte get launchplan command #4613
• [Docs] move aws scheduler docs to the legacy section #4513
• [Docs] document the process of debugging the mpi operator plugin installation #4464
• [Docs] provide clarification in the docs regarding interruptible behavior when using map tasks #4462
• [Docs] document how to set the cache for container tasks #4461
• [Docs] document file and directory streaming #4460
• [Docs] document the workflow failure policy #4459
• [Docs] document cuda and requirements.txt imagespec features #4457
• [Docs] need to improve the documentation around data flow between flyte tasks #4456
• [Docs] Note that domains are fixed at the global level #4392
• [Docs] add additional documentation for the with_overrides feature #4067
• [BUG] UI adds spaces to strings inside structs #4052
• [Docs] Spot/interruptible docs imply retries come from the user retry budget #3956
• [Docs] flytectl demo vs flytectl sandbox #3791
• [Docs] Add User Guide section: "Data Connectors" #3341
• [Docs] Explicitly note that nested dataclasses are not supported in the type system #3328
• [Docs] Explain how the type system and data passing works in Flyte Fundamentals #3322
• [Docs] Fix up caching docs as per user feedback #3249
• [Docs] How to verify that the GRPC service of flyteadmin works as expected #3163
• [Docs] Document how to mount and dynamically create persistent volume #2754
• [Docs] Add information about behaviors of resource defaults and limits #2513

Flytekit

Contribution Guide

• [Core feature] Skyplane flytekit plugin #3005
• [Core feature] Integrate with Soda.io #2963

Flyteconsole

Contribution Guide

• [BUG] Docs | Side menu truncated on reduced widths #5194
• [Core feature] Simplify the local development environment for flyteconsole #5099
• [UI Feature] Set timestamps to local timezone in console #2908

---

We hope you enjoy the contribution experience and are looking forward to seeing what you come up with!

Happy Hacktoberfest!