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.

Sign up for GitHub

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

[monodocs] Fix build failure #5425

Merged
merged 1 commit into from
May 29, 2024
Merged

[monodocs] Fix build failure #5425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user_guide/data_types_and_io/flytedirectory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ You can run the workflow locally as follows:

```{rli} https://raw.githubusercontent.com/flyteorg/flytesnacks/master/examples/data_types_and_io/data_types_and_io/folder.py
Copy link
Contributor Author

@eapolinario eapolinario May 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@neverett , this could have been caught in flyteorg/flytesnacks#1660 if this reference didn't mention master as the branch, but the branch name was not used, which means that only after this was merged to master the error manifests itself.

This seems to be a pattern in our docs, but I'm wondering if we shouldn't lean on a bit of automation to catch these at PR time.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, we do reference master in all the places where we use the rli directive. I'm in favor of automation to catch these at PR time, although I'm not sure what that would look like -- I can make a Linear ticket to investigate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It turns out that we had another failure (fixed in #5428). Notice how in the aforementioned PR we're trading staleness (as in changes to the original file will not be reflected to the docs since we're pointing to a specific SHA) for consistency.

@neverett , can you open a Linear ticket to discuss which approach we should take going forward?

Copy link
Contributor

Choose a reason for hiding this comment

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

@eapolinario in the interest of avoiding build failures, I'll switch all rli URLs to SHAs for now, plus open a ticket so we can discuss how we want to approach this long term. When I started the work of separating docs from example code, the user guide examples were fairly stable, but they've seen a lot of activity in the last few weeks, and I assume will continue to be updated regularly going forward.

:caption: data_types_and_io/folder.py
:lines: 98-118
:lines: 94-114
```

[flytesnacks]: https://github.com/flyteorg/flytesnacks/tree/master/examples/data_types_and_io/
Loading