-
Notifications
You must be signed in to change notification settings - Fork 681
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
Conversation
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]>
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]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
There was a problem hiding this 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!
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
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