cleanup external add-ons section + add github links to components sidebar #3640
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: thesuperzapper The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
@zijianjoy This should hopefully be one of the last huge website cleanups, it's one I have been putting off for ages. It's to clean up the It adds redirects, so a root approver is needed. |
|
@zijianjoy during today's community meeting, and @andreyvelich suggested that we make the warning about external-add-ons less forceful, I have updated the wording in ac46ade. |
|
@zijianjoy since this is more of a structural change, you are probably the only person who can approve this, I am interested to hear any comments you have. I think this update is important because it is the first step towards standardizing how we promote external projects. |
| icon = "fa-brands fa-github" | ||
| +++ | ||
|
|
||
| The Kubeflow Central Dashboard is developed in the [`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow/tree/master/components/centraldashboard) repository. |
There was a problem hiding this comment.
Do these pages work for you ?
When I click to the GitHub repository in the left menu it redirects me to the GitHub.
Or this page is for users who directly access it via URL ?
E.g.
https://deploy-preview-3640--competent-brattain-de2d6d.netlify.app/docs/components/central-dash/github/
There was a problem hiding this comment.
You are correct, these links are here not because they are accessible, but because Docsy (our template engine) requires them.
Users are actually redirected automatically when they click the sidebar link.
| +++ | ||
|
|
||
| {{% alert title="Add-On Ownership" color="warning" %}} |
There was a problem hiding this comment.
Should we use other colours rather than red here (e.g. Yellow)?
We use red colour to show beta or legacy supported distributions which might confuse users.
For example, Kubernetes uses yellow colour for other tools: https://kubernetes.io/docs/reference/tools/#minikube.
cc @akgraner @jbottum
|
|
||
| title = "Introduction" | ||
| description = "A brief introduction to BentoML Yatai" | ||
| weight = 1 |
| description = "A brief introduction to Elyra" | ||
| weight = 10 | ||
| +++ | ||
|
|
There was a problem hiding this comment.
We need Elyra folks to review this change.
Please take a look.
/assign @hsinhoyeh @akfmdl @akchinSTC
| +++ | ||
| title = "Getting Started" | ||
| description = "Getting started with Feast and Kubeflow" | ||
| weight = 20 | ||
| +++ |
There was a problem hiding this comment.
We need FEAST folks to review this change.
/assign @woop @sudohainguyen @adchia
| @@ -0,0 +1,57 @@ | |||
| +++ | |||
| title = "Introduction" | |||
| description = "A brief introduction to KServe" | |||
There was a problem hiding this comment.
We need KServe folks to review it.
/assign @yuzisun @terrytangyuan @sivanantha321
There was a problem hiding this comment.
This page is very outdated. Feel free to borrow the existing README from KServe.
In the meantime, we should move KServe out of external add-ons.
| weight = 70 | ||
| +++ | ||
|
|
||
| ## What is MLRun? |
There was a problem hiding this comment.
We need MLRun folks to review this change:
/assign @alexiguazio @mohamadmansourX
|
@andreyvelich: GitHub didn't allow me to assign the following users: akchinSTC, issheng, hsinhoyeh, akfmdl. Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@andreyvelich: GitHub didn't allow me to assign the following users: ssheng. Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@andreyvelich: GitHub didn't allow me to assign the following users: alexiguazio, mohamadmansourX. Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@andreyvelich: GitHub didn't allow me to assign the following users: sudohainguyen, adchia. Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@andreyvelich: GitHub didn't allow me to assign the following users: sivanantha321. Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@jbottum @andreyvelich as discussed in the community meeting today, my request is that we review these changes for any significant issues, and if none are raised in the next few weeks, we merge it. Because the diff is hard to understand (because it has a lot of reformatting with minimal actual content changes), I recommend people use the deploy preview to browse the updated "external add-ons" section and get a feel for if they think it is better than the current website state: |
thesuperzapper
force-pushed
the
cleanup-external-add-ons
branch
from
ac46ade
to
5be9ffa
Compare
|
Thank you for the update @thesuperzapper, I want to hear thoughts for this comment: #3640 (comment) Please other WG leads review this PR: cc @kubeflow/release-team @kubeflow/wg-training-leads @kubeflow/wg-pipeline-leads @kubeflow/wg-notebooks-leads @kubeflow/wg-manifests-leads |
|
@andreyvelich we should try and get this refactor merged, as the external add-on pages are really out of date right now. |
I agree, do we want to keep external add-ons in our website only for folks who are currently active and remove out-of-date docs ? E.g. I asked various docs owners to check their docs on Jan 11th, and we didn't get any responses. Any thoughts @kubeflow/kubeflow-steering-committee ? |
Happy to contribute some meaningful updates here! |
| @@ -1,19 +1,5 @@ | |||
| +++ | |||
| title = "Elyra" | |||
| description = "Elyra enables data scientists to visually create end-to-end machine learning (ML) workflows." | |||
| description = "Elyra: AI-centric extensions to JupyterLab" | |||
There was a problem hiding this comment.
I would still use the old description here, as in the context of Kubeflow, the most value from Elyra is to help visually create the workflow/pipelines.
| icon = "fa-brands fa-github" | ||
| +++ | ||
|
|
||
| Elyra is developed in the [`feast-dev/feast`](https://github.com/feast-dev/feast) repository. |
There was a problem hiding this comment.
| Elyra is developed in the [`feast-dev/feast`](https://github.com/feast-dev/feast) repository. | |
| Feast is developed in the [`feast-dev/feast`](https://github.com/feast-dev/feast) repository. |
| icon = "fa-brands fa-github" | ||
| +++ | ||
|
|
||
| Elyra is developed in the [`elyra-ai/elyra`](https://github.com/elyra-ai/elyra) repository. |
There was a problem hiding this comment.
| Elyra is developed in the [`elyra-ai/elyra`](https://github.com/elyra-ai/elyra) repository. | |
| Elyra is a member of the Linux Foundation AI (https://lfaidata.foundation/projects/elyra/) and developed in the [`elyra-ai/elyra`](https://github.com/elyra-ai/elyra) repository. |
This PR improves the website in the following ways:
componentssection, adds links to the Kubeflow GitHub reposexternal add-ons, to give each add-on (which is already on the website) its own small section containing:Screenshot
Links to Kubeflow Git Repos
Updated External Add-Ons Page