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 rli bug #6008

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Docs rli bug #6008

merged 2 commits into from
Nov 14, 2024

Conversation

cosmicBboy
Copy link
Contributor

Why are the changes needed?

Code snippets using the rli directive aren't rendering in the docs: https://docs.flyte.org/en/latest/user_guide/basics/hello_world.html

image

The root cause is that the readthedocs build server gets 403 errors when trying to get files from github

https://app.readthedocs.org/projects/flyte/builds/26258764/


/home/docs/checkouts/readthedocs.org/user_builds/flyte/checkouts/latest/docs/user_guide/testing/mocking_tasks.md:10017: WARNING: HTTP request returned error code 403
--
1112 | /home/docs/checkouts/readthedocs.org/user_builds/flyte/checkouts/latest/docs/user_guide/testing/mocking_tasks.md:10024: WARNING: HTTP request returned error code 403
1113 | /home/docs/checkouts/readthedocs.org/user_builds/flyte/checkouts/latest/docs/user_guide/testing/mocking_tasks.md:10031: WARNING: HTTP request returned error code 403
1114 | /home/docs/checkouts/readthedocs.org/user_builds/flyte/checkouts/latest/docs/user_guide/testing/mocking_tasks.md:10038: WARNING: HTTP request returned error code 403
1115 | /home/docs/checkouts/readthedocs.org/user_builds/flyte/checkouts/latest/docs/user_guide/testing/mocking_tasks.md:10045: WARNING: HTTP request returned error code 403


What changes were proposed in this pull request?

Since we're already pulling in content from flytesnacks for the integrations and tutorials, we can just use literalinclude instead of rli to render the code snippets.

Check all the applicable boxes

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

Readthedocs is having issues with the remoteliteralinclude directive.
At build time it gets 403 errors when trying to fetch remote files from
github.

Signed-off-by: Niels Bantilan <[email protected]>
Copy link

codecov bot commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.95%. Comparing base (f20b8aa) to head (069501e).
Report is 5 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6008   +/-   ##
=======================================
  Coverage   36.95%   36.95%           
=======================================
  Files        1310     1310           
  Lines      131464   131464           
=======================================
+ Hits        48587    48588    +1     
+ Misses      78656    78655    -1     
  Partials     4221     4221           
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.07% <ø> (ø)
unittests-flytecopilot 22.23% <ø> (ø)
unittests-flytectl 62.39% <ø> (ø)
unittests-flyteidl 6.95% <ø> (ø)
unittests-flyteplugins 53.83% <ø> (ø)
unittests-flytepropeller 43.10% <ø> (ø)
unittests-flytestdlib 55.31% <ø> (+0.01%) ⬆️

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.

@ppiegaze ppiegaze merged commit 24113f6 into master Nov 14, 2024
51 checks passed
@ppiegaze ppiegaze deleted the docs-rli-bug branch November 14, 2024 13:41
@eapolinario eapolinario mentioned this pull request Nov 14, 2024
3 tasks
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