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

DOC-431 Document pyflyte option --overwrite-cache #5567

Merged

Conversation

ppiegaze
Copy link
Member

Tracking issue

https://linear.app/unionai/issue/DOC-431/document-pyflyte-option-overwrite-cache

Why are the changes needed?

Info missing

What changes were proposed in this pull request?

Clarify caching parameters and add --overwrite-cache details

@ppiegaze ppiegaze requested a review from pingsutw July 18, 2024 11:14
@ppiegaze ppiegaze requested a review from neverett as a code owner July 18, 2024 11:14
Copy link

codecov bot commented Jul 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.90%. Comparing base (0b39839) to head (21f5b4f).
Report is 141 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #5567       +/-   ##
===========================================
- Coverage   60.98%   35.90%   -25.09%     
===========================================
  Files         796     1301      +505     
  Lines       51676   109401    +57725     
===========================================
+ Hits        31515    39281     +7766     
- Misses      17261    66023    +48762     
- Partials     2900     4097     +1197     
Flag Coverage Δ
unittests-datacatalog 51.37% <ø> (-17.95%) ⬇️
unittests-flyteadmin 53.70% <ø> (-5.03%) ⬇️
unittests-flytecopilot 12.17% <ø> (-5.62%) ⬇️
unittests-flytectl 62.28% <ø> (-5.16%) ⬇️
unittests-flyteidl 7.09% <ø> (-71.97%) ⬇️
unittests-flyteplugins 53.31% <ø> (-8.46%) ⬇️
unittests-flytepropeller 41.75% <ø> (-15.73%) ⬇️
unittests-flytestdlib 55.27% <ø> (-10.42%) ⬇️

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.

neverett
neverett previously approved these changes Jul 23, 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.

A few structural suggestions, otherwise LGTM

docs/user_guide/development_lifecycle/caching.md Outdated Show resolved Hide resolved
docs/user_guide/development_lifecycle/caching.md Outdated Show resolved Hide resolved
docs/user_guide/development_lifecycle/caching.md Outdated Show resolved Hide resolved
docs/user_guide/development_lifecycle/caching.md Outdated Show resolved Hide resolved
@neverett neverett changed the title Document pyflyte option --overwrite-cache DOC-431 Document pyflyte option --overwrite-cache Jul 23, 2024
@ppiegaze ppiegaze force-pushed the peeter/doc-431-document-pyflyte-option-overwrite-cache branch from 927dc5c to 9358475 Compare July 24, 2024 11:00
@ppiegaze ppiegaze requested a review from neverett July 24, 2024 11:00
ppiegaze added 3 commits July 24, 2024 13:09
Signed-off-by: Peeter Piegaze <[email protected]>
Signed-off-by: Peeter Piegaze <[email protected]>
@ppiegaze ppiegaze force-pushed the peeter/doc-431-document-pyflyte-option-overwrite-cache branch from 4a31f17 to edf31c8 Compare July 24, 2024 11:09
Signed-off-by: Peeter Piegaze <[email protected]>
@ppiegaze ppiegaze requested review from neverett and removed request for pingsutw July 24, 2024 14:28
neverett
neverett previously approved these changes Jul 24, 2024
Signed-off-by: Peeter Piegaze <[email protected]>
@ppiegaze ppiegaze requested a review from neverett July 26, 2024 11:43
@ppiegaze
Copy link
Member Author

ppiegaze commented Jul 26, 2024

@neverett Please approve.

Took some time to figure out why links of the form [Some text](#some-anchor) were not working. It turns out that anchor links like this never worked in Flyte docs (this PR is appartently the first to introduce them). They do work now, since I added the line

myst_heading_anchors = 6

to the conf.py

@ppiegaze ppiegaze merged commit 025296a into master Jul 29, 2024
49 of 50 checks passed
@ppiegaze ppiegaze deleted the peeter/doc-431-document-pyflyte-option-overwrite-cache branch July 29, 2024 13:00
vlibov pushed a commit to vlibov/flyte that referenced this pull request Aug 16, 2024
* Document pyflyte option --overwrite-cache

Signed-off-by: Peeter Piegaze <[email protected]>

* Changes as per review

Signed-off-by: Peeter Piegaze <[email protected]>

* fix as per review

Signed-off-by: Peeter Piegaze <[email protected]>

* fix link

Signed-off-by: Peeter Piegaze <[email protected]>

* adjust wording

Signed-off-by: Peeter Piegaze <[email protected]>

* remove links to anchors, they don't work in Flyte dcos

Signed-off-by: Peeter Piegaze <[email protected]>

* try anchor links again

Signed-off-by: Peeter Piegaze <[email protected]>

* add back anchor links

Signed-off-by: Peeter Piegaze <[email protected]>

---------

Signed-off-by: Peeter Piegaze <[email protected]>
Signed-off-by: Vladyslav Libov <[email protected]>
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