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

[WAIT TO MERGE] Use remoteliteralinclude for code in user guide docs #5207

Merged
merged 18 commits into from
Apr 19, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Apr 9, 2024

Why are the changes needed?

Replace embedded code snippets with rli (remoteliteralinclude) directives to point to runnable example code in the Flytesnacks repo. That way, we're always pointing to tested, runnable code.

Check all the applicable boxes

  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Merge flyteorg/flytesnacks#1630 first.

Docs link

New user guide with code included from flytesnacks via rli directive: https://flyte--5207.org.readthedocs.build/en/5207/user_guide/index.html

Signed-off-by: nikki everett <[email protected]>
nikki everett added 11 commits April 15, 2024 12:28
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
nikki everett added 2 commits April 17, 2024 16:48
Signed-off-by: nikki everett <[email protected]>
Copy link

codecov bot commented Apr 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.10%. Comparing base (7287470) to head (fd30192).
Report is 9 commits behind head on master.

❗ Current head fd30192 differs from pull request most recent head 044576a. Consider uploading reports for the commit 044576a to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5207      +/-   ##
==========================================
- Coverage   58.60%   58.10%   -0.50%     
==========================================
  Files         568      516      -52     
  Lines       51121    47453    -3668     
==========================================
- Hits        29958    27573    -2385     
+ Misses      18748    17622    -1126     
+ Partials     2415     2258     -157     
Flag Coverage Δ
unittests 58.10% <ø> (-0.50%) ⬇️

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.

nikki everett added 2 commits April 18, 2024 11:23
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett marked this pull request as ready for review April 18, 2024 20:29
@neverett neverett requested a review from ppiegaze as a code owner April 18, 2024 20:29
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 18, 2024
Signed-off-by: nikki everett <[email protected]>
Copy link
Member

@ppiegaze ppiegaze left a comment

Choose a reason for hiding this comment

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

I checked a few of the RLIs. They seem to work well. I really like this. I think it will be a game changer for us!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 19, 2024
@neverett neverett merged commit 7e99ba4 into master Apr 19, 2024
46 checks passed
@neverett neverett deleted the nikki/docs/user-guide-reorg branch April 19, 2024 18:18
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 lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants