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

Refactor external add-ons section #3836

Merged

Conversation

thesuperzapper
Copy link
Member

This PR refactors and cleans up the "External Add-Ons" section.

The key changes this PR mages:

  1. Gives each project its own section, with 3 links on the sidebar:
    • Introduction - a brief overview of What is XXXX? and "How to use XXXX with Kubeflow?"
    • Website - a link to the project's docs website
    • GitHub Repo - a link to the open-source projects GitHub repo
  2. Creates the following sections under External Add-Ons:
    • KServe
    • Feast
    • Elyra
  3. Projects which were removed:
    • BentoML Yati (not open source - Elastic v2 license, and is also abandoned)
    • Seldon Core (not open source - Business Source License 1.1)
    • MLRun (seemingly a competing project to Kubeflow, unclear why it was ever included)
      • If the KSC decides they still want to elevate a competing project, I have a single commit which can be reverted to add a section for MLRun.
    • All other specific serving runtimes (as they are included in KServe)

In the "Introduction" pages, I have largley left the wording unchanged, and mostly tried to structure everything under the two core headings: "What is XXXX?", and "How do I use XXXX with Kubeflow?"

Screenshots

Section Overview

External-Add-Ons-Kubeflow

Feast Section

Feast-Kubeflow

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
@thesuperzapper
Copy link
Member Author

@andreyvelich @franciscojavierarceo @jbottum this is the PR to clean up the External Add-Ons section, I would appreciate your review.

See the preview site here:

@@ -1,3 +0,0 @@
approvers:
- woop
- franciscojavierarceo
Copy link
Contributor

@franciscojavierarceo franciscojavierarceo Aug 13, 2024

Choose a reason for hiding this comment

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

Can we keep this file? Or rather make an equivalent feast one?

Copy link
Member Author

Choose a reason for hiding this comment

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

The purpose of these sections is not to provide up to date information, it is to provide a brief "evergreen" explanation of what the add-on is, and how it relates to Kubeflow.

I would prefer if the root approvers of the Kubeflow website are aware and approve each proposed change, to avoid messaging conflicts.

Even without being an approver, you or others can raise PRs to propose updates.

@franciscojavierarceo
Copy link
Contributor

franciscojavierarceo commented Aug 13, 2024

@andreyvelich @franciscojavierarceo @jbottum this is the PR to clean up the External Add-Ons section, I would appreciate your review.

See the preview site here:

Thank you for this! I left some small nits.

Also, it may not really be necessary but I thought I'd mention that we've updated the architecture diagram on the feast documentation to reflect storing Request Sources which we plan to include in feast-dev/feast#4376

image

@rimolive
Copy link
Member

Changes look great to me, but my initial concern is still valid. There's missing instructions on how to deploy and integrate Feast with Kubeflow. @franciscojavierarceo any change to provide these instructions in Feast docs while we work to bring the manifests back in Kubeflow?

@franciscojavierarceo
Copy link
Contributor

Changes look great to me, but my initial concern is still valid. There's missing instructions on how to deploy and integrate Feast with Kubeflow. @franciscojavierarceo any change to provide these instructions in Feast docs while we work to bring the manifests back in Kubeflow?

I'm going to make a follow up PR with how to do this after I add the manifests back in but we shouldn't have to block on that imo.

@franciscojavierarceo
Copy link
Contributor

But @dmartinol @jeremyary we should discuss that

@ederign
Copy link
Member

ederign commented Aug 15, 2024

I really like the structural changes @thesuperzapper ! Please just accommodate @franciscojavierarceo requests if you agree with them.

/lgtm

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
@google-oss-prow google-oss-prow bot removed the lgtm label Aug 19, 2024
@thesuperzapper
Copy link
Member Author

@franciscojavierarceo I have applied your updates, and added the diagram, please see the new preview site:

Copy link
Contributor

@franciscojavierarceo franciscojavierarceo left a comment

Choose a reason for hiding this comment

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

/lgtm

Thanks for this!!

@thesuperzapper
Copy link
Member Author

@terrytangyuan we need a root approver because I had to fix files outside the KFP directory to avoid broken links.

I'm pretty sure this is ready to merge now.

Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

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

Thanks!

/lgtm
/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: franciscojavierarceo, terrytangyuan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit cb2f6d7 into kubeflow:master Aug 20, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants