Jupyter notebook basic example

[Mecoli1219]

flyteorg/flyte#5907

[davidmirror-ops]

@Mecoli1219 please check the failing docs build. Fixing it should be straightforward. Thank you!

[Mecoli1219]

@davidmirror-ops I'd like to get your input on the categorization of this example. I'm considering whether it should be in tutorial, integration, or the current examples/basics/ directory. Given that it demonstrates fundamental Jupyter Notebook integration with Flyte, which location would be most appropriate?

[davidmirror-ops]

this is going to change as the end goal is to host this post on flyte.org right?

[Mecoli1219]

Yes, correct. However, if this is going to be moved into the basics folder, I don't think this README.md file is needed

[davidmirror-ops]

@Mecoli1219 I think examples/basics is the best location as it's where most of users getting started look at, and we want to surface how this integration enables them to use a familiar tool with Flyte.
Thank you!

[Mecoli1219]

@davidmirror-ops @samhita-alla Can you help me review this PR? Thanks

[samhita-alla]

shouldn't this be updated in the flyte repo: https://github.com/flyteorg/flyte/tree/master/docs/user_guide/basics? @davidmirror-ops do you know?

[davidmirror-ops]

@samhita-alla excellent question. Both rendering the notebook as-is on a page in the flyte repo or keeping it in flytesnacks seems to require enabling one of the supported Sphynx extensions.
I guess keeping it on flytesnacks maintains the approach of storing the examples on a dedicated repo, and one could reference it from the flyte repo using notebooks/<notebook_name>
@cosmicBboy @eapolinario what do you think?

[Mecoli1219]

@samhita-alla Oh... I finally understand what you mean. I'll open a PR in the flyte repo that updates this example in the basics example directory.

[samhita-alla]

@Mecoli1219 I think we want the example in the flytesnacks repo, but we may need to add the extension. If there's a way to get a preview URL, that'd be helpful. The preview URL link included in the checks doesn’t have the user guide, so it’s hard to confirm if the docs are rendering correctly.

[Mecoli1219]

@samhita-alla I am not sure what we are expecting now. As far as I know, we are only adding the .ipynb example in the basics directory in flytesnacks. However, we should create a new page (perhaps a .md file) in the flyte repo, letting it render part of the code in the flytesnacks' .ipynb file. The concern now is that in the flyte repo, we didn't have a Github Actions to verify the newly created page, so I should somehow build the document locally and manually check the correctness of the page.

Does this align with what you were thinking?

[davidmirror-ops]

@Mecoli1219 Agree with creating a new page on the basics section of the Flyte repo and reference this notebook from there. Conceptually, this is an extension of Flyteremote but considering how prominent can be for new users, having on the basics section looks like a good option to me. I think we are more inclined to use the MystNB extension to render the Notebook, though I'm not sure how/if to render specific cells interleaved byt regular text in the markdown. I'm sorry if this has caused confusion, this is the first notebook example we host afaict.

[Mecoli1219]

Got it! Let me try it out. By the way, I think placing the interactive mode content in Flyte Fundamentals would be more appropriate for the context.