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] Improve registration patterns docs #5669

Closed
2 tasks done
Tracked by #5783
davidmirror-ops opened this issue Aug 19, 2024 · 5 comments · Fixed by #5808
Closed
2 tasks done
Tracked by #5783

[Docs] Improve registration patterns docs #5669

davidmirror-ops opened this issue Aug 19, 2024 · 5 comments · Fixed by #5808
Assignees
Labels
documentation Improvements or additions to documentation documentation-backlogged For internal use. Reserved for community team workflow. good first issue Good for newcomers hacktoberfest

Comments

@davidmirror-ops
Copy link
Contributor

davidmirror-ops commented Aug 19, 2024

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?

  • Yes

Have you read the Code of Conduct?

  • Yes
@davidmirror-ops davidmirror-ops added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Aug 19, 2024
Copy link

runllm bot commented Aug 19, 2024

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!

@eapolinario eapolinario added documentation-backlogged For internal use. Reserved for community team workflow. and removed untriaged This issues has not yet been looked at by the Maintainers labels Aug 22, 2024
@siiddhantt
Copy link
Contributor

siiddhantt commented Oct 3, 2024

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

@davidmirror-ops
Copy link
Contributor Author

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

@siiddhantt
Copy link
Contributor

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

@JiangJiaWei1103
Copy link
Contributor

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

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 documentation-backlogged For internal use. Reserved for community team workflow. good first issue Good for newcomers hacktoberfest
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants