flyteorg / flyte

Scalable and flexible workflow orchestration platform that seamlessly unifies data, ML and analytics stacks.
https://flyte.org
Apache License 2.0
5.76k stars 655 forks source link

[Docs] Improve registration patterns docs #5669

Closed davidmirror-ops closed 6 days ago

davidmirror-ops commented 2 months ago

Description

Questions related to this topic lead to think that expanding and updating the Registering workflows section would be useful to make sure it's easier to understand.

Question Question

Are you sure this issue hasn't been raised already?

Have you read the Code of Conduct?

runllm[bot] commented 2 months ago

To improve the Registering workflows section, consider the following enhancements:

  1. Clarify Registration Patterns: Provide more detailed explanations and examples for each registration pattern, including pyflyte run, pyflyte register, and flytectl register. Highlight their use cases and differences.
  2. Add Visual Aids: Include diagrams or flowcharts to visually represent the registration process and different patterns.
  3. Expand on Custom Dependencies: Offer more examples and detailed steps for handling custom dependencies, including Dockerfile modifications and ImageSpec configurations.
  4. Include Common Troubleshooting Tips: Add a section for common issues and their solutions during the registration process.

Would you like more detail on any specific enhancement?

Sources:


This is an AI-generated response and your feedback is appreciated! Please leave a 👍 if this is helpful and 👎 if it is not.

Mention @runllm to ask follow-up questions. See runllm.com for more!

siiddhantt commented 1 month ago

hi, could I be assigned this issue, I'd like to work on it!

davidmirror-ops commented 1 month ago

@siiddhantt done. Please let us know soon if you have questions or need help. Thanks!

siiddhantt commented 1 month ago

Thanks @davidmirror-ops , I've opened a PR for this issue. Do lmk if it needs improvement or anything else.

JiangJiaWei1103 commented 6 days ago

Hello, could I also work on this issue? Thanks.