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] Update for image spec/fast register notes #5726

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

wild-endeavor
Copy link
Contributor

@wild-endeavor wild-endeavor commented Sep 6, 2024

Why are the changes needed?

Update to docs to clarify pyflyte command args and the relationship between fast register and imagespec.

What changes were proposed in this pull request?

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Related to flyteorg/flytekit#2731

Docs link

Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com>
Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com>
Copy link

codecov bot commented Sep 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.20%. Comparing base (a058fd1) to head (e5fbee4).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5726      +/-   ##
==========================================
- Coverage   36.21%   36.20%   -0.01%     
==========================================
  Files        1303     1303              
  Lines      109560   109560              
==========================================
- Hits        39675    39669       -6     
- Misses      65765    65771       +6     
  Partials     4120     4120              
Flag Coverage Δ
unittests-datacatalog 51.37% <ø> (ø)
unittests-flyteadmin 55.60% <ø> (-0.04%) ⬇️
unittests-flytecopilot 12.17% <ø> (ø)
unittests-flytectl 62.17% <ø> (ø)
unittests-flyteidl 7.12% <ø> (ø)
unittests-flyteplugins 53.35% <ø> (ø)
unittests-flytepropeller 41.76% <ø> (ø)
unittests-flytestdlib 55.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wild-endeavor
Copy link
Contributor Author

@neverett could you take a look at this please?

neverett
neverett previously approved these changes Sep 6, 2024
Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some suggestions for clarity, but overall LGTM.

docs/flyte_fundamentals/registering_workflows.md Outdated Show resolved Hide resolved
docs/flyte_fundamentals/registering_workflows.md Outdated Show resolved Hide resolved
docs/flyte_fundamentals/registering_workflows.md Outdated Show resolved Hide resolved
docs/flyte_fundamentals/registering_workflows.md Outdated Show resolved Hide resolved
docs/flyte_fundamentals/registering_workflows.md Outdated Show resolved Hide resolved
docs/flyte_fundamentals/registering_workflows.md Outdated Show resolved Hide resolved
docs/user_guide/customizing_dependencies/imagespec.md Outdated Show resolved Hide resolved
docs/user_guide/customizing_dependencies/imagespec.md Outdated Show resolved Hide resolved
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com>
@wild-endeavor wild-endeavor marked this pull request as ready for review September 8, 2024 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants