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

Add flyin plugin to monodocs integrations page #4582

Merged
merged 1 commit into from
Dec 12, 2023
Merged

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Dec 12, 2023

Why are the changes needed?

Currently, flyteorg/flytesnacks#1314 is failing the monodocs build step because it adds a new plugin page that has not been added to the integrations TOC.

What changes were proposed in this pull request?

Adds the flyin plugin index link to the integrations docs config page.

Check all the applicable boxes

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

Related PRs

flyteorg/flytesnacks#1314

Docs link

TBD

Signed-off-by: nikki everett <[email protected]>
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Dec 12, 2023
@neverett neverett changed the title Add flyin plugin to monodocs TOC Add flyin plugin to monodocs integrations page Dec 12, 2023
Copy link

codecov bot commented Dec 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e2b1ff2) 58.98% compared to head (c7bec00) 58.97%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4582      +/-   ##
==========================================
- Coverage   58.98%   58.97%   -0.02%     
==========================================
  Files         621      621              
  Lines       52483    52483              
==========================================
- Hits        30958    30951       -7     
- Misses      19058    19065       +7     
  Partials     2467     2467              
Flag Coverage Δ
unittests 58.97% <ø> (-0.02%) ⬇️

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.

Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @neverett !

I am okay with merging this first to unblock flyteorg/flytesnacks#1314. I left a comment about improving the workflow moving forward.

@@ -210,4 +212,5 @@ flytesnacks/examples/snowflake_plugin/index
flytesnacks/examples/databricks_plugin/index
flytesnacks/examples/bigquery_plugin/index
flytesnacks/examples/airflow_plugin/index
flytesnacks/examples/flyin_plugin/index
Copy link
Member

Choose a reason for hiding this comment

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

@cosmicBboy The workflow for adding a new plugin example is a bit involved. We have to update flyte's TOC with an example that does not exist and then add the example to flytesnacks.

Can this TOC be auto generated from flytesnacks during the doc build process? (Implementation-wise it would auto generate a TOC file that we .. include:: in this spot.)

@cosmicBboy
Copy link
Contributor

hey @neverett, I'm actually working on a PR to changes the toctree such that monodocs uses the integrations, userguide, and tutorial toctrees that are in flytesnacks, so that we don't have to make updates to both repos when adding new examples, PR incoming!

@cosmicBboy
Copy link
Contributor

we can merge this to unblock the flytesnacks PR

@neverett neverett merged commit b14f1ac into master Dec 12, 2023
39 of 41 checks passed
@neverett neverett deleted the nikki-fix-toc branch December 12, 2023 20:23
pvditt pushed a commit that referenced this pull request Dec 13, 2023
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: Paul Dittamo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants