website icon indicating copy to clipboard operation
website copied to clipboard

Update Home page to include main components and their GitHub Star count

Open paravatha opened this issue 2 years ago • 21 comments

Feature request On the https://www.kubeflow.org/ home page, add the below components image/logo with their Github repo link and the respective Github repo star count

  • Kubeflow, https://github.com/kubeflow/kubeflow, 13.1k stars
  • Pipelines, https://github.com/kubeflow/pipelines, 3.4k stars
  • KServe, https://github.com/kserve/kserve, 2.6k stars
  • Katib, https://github.com/kubeflow/katib, 1.4k stars
  • Training Operator, https://github.com/kubeflow/training-operator, 1.4k stars

Something like this is done by Argo project for their components, reference https://argoproj.github.io/

paravatha avatar Nov 15 '23 05:11 paravatha

I think this is great if someone wants to contribute it!

franciscojavierarceo avatar Jan 27 '25 18:01 franciscojavierarceo

/help

varodrig avatar Jan 27 '25 19:01 varodrig

@varodrig: This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to this:

/help

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.

google-oss-prow[bot] avatar Jan 27 '25 19:01 google-oss-prow[bot]

/good-first-issue

andreyvelich avatar Jan 27 '25 19:01 andreyvelich

@andreyvelich: This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

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.

google-oss-prow[bot] avatar Jan 27 '25 19:01 google-oss-prow[bot]

Hi, I feel at least for KubeFlow we should have github star banner for sure. Something like this, I will improve the UI and attract new contributors.

Image

But for individual components to have that banner, I am personally not very fan of that since these components come under the umbrella of Kubeflow MLF, while Argo's individual tools are a bit more independent from each other.

For distributions star's, we already have a related PR #3598

Feel free to suggest what you all think would be better.

jaiakash avatar Jan 29 '25 16:01 jaiakash

Your thoughts on the above suggestion, @varodrig @andreyvelich ?

jaiakash avatar Feb 01 '25 09:02 jaiakash

I would prefer if we have star banner for every Kubeflow project, since all of them can be used as a standalone project. Maybe we can add it to the homepage: https://www.kubeflow.org/

andreyvelich avatar Feb 01 '25 20:02 andreyvelich

Hi, so I was kinda working on it to find which one suits better. I added shields icon, since it can be easily added to markdown.

Image

jaiakash avatar Feb 10 '25 16:02 jaiakash

Looks amazing @jaiakash. WDYT @thesuperzapper ?

andreyvelich avatar Feb 10 '25 16:02 andreyvelich

Image

For the main kubeflow repo, I added it in the navbar. Personally I feel for this navbar we should have a better design. Something like this

Image

Fork link: https://github.com/jaiakash/website/tree/github-stars

jaiakash avatar Feb 10 '25 16:02 jaiakash

@andreyvelich I am ok with having the kubeflow/kubeflow stars at the top, but I think we need to format it a bit more consistently with the page, especially considering:

  1. What it looks like on mobile (or with small horizontal screen)
  2. What it might look like on the new dark mode (https://github.com/kubeflow/website/pull/3981)

However, I don't like the per-component start counts on the homepage for a few reasons:

  1. it distracts from the card titles
  2. it creates a bunch of new clickable links on the homepage
  3. it is less clear what the intended "action" from these cards is
    • we should be trying to have people click through to the docs for the components they are interested in, not leave the website to GitHub

Instead, we could possibly include the star counts on the overview page on each component, instead of the homepage.

thesuperzapper avatar Feb 10 '25 17:02 thesuperzapper

Also, there is a slight privacy (and website-reliability) concern with including the "shields" image (which is hosted by another service) on literally every page of the website.

thesuperzapper avatar Feb 10 '25 17:02 thesuperzapper

I think, it is less important to have stars for kubeflow/kubeflow, since this repo won't have any projects after: https://github.com/kubeflow/kubeflow/issues/7549 However, for the individual components we should show it somewhere. I like the Argo Docs, and how they show stars for Argo CD, Argo Workflows, etc: https://argoproj.github.io/cd/ Can we try to design similar for Kubeflow Projects ? cc @kubeflow/kubeflow-steering-committee @franciscojavierarceo @juliusvonkohout

andreyvelich avatar Feb 10 '25 17:02 andreyvelich

I have a slightly different opinion here. GitHub stars is a misleading metric and people often take it in the wrong way. Not a strong objection though.

If we do end up doing this, we should not include stars from kubeflow/kubeflow repo.

terrytangyuan avatar Feb 10 '25 17:02 terrytangyuan

I agree with @thesuperzapper 's first point, We should have a star count for kubeflow/kubeflow on the main page while considering mobile and dark modes. But seeing https://github.com/kubeflow/kubeflow/issues/7549, that option is sustainable only till the kubeflow/kubeflow is active.

For ques,

  1. it creates a bunch of new clickable links on the homepage
  • Nope, those Github start components are not clickable in themselves.
  1. it is less clear what the intended "action" from these cards is. we should be trying to have people click through to the docs for the components they are interested in, not leave the website to GitHub
  • Yeah, that is what is happening; if the user clicks on that, it redirects to the doc page of that component, not Github.

  1. it distracts from the card titles Instead, we could include the star counts on the overview page on each component instead of the homepage.

Actually, I am looking to create a custom component that is more suited for the KubeFlow website's theme, covering both mobile view and dark mode. But my doubt is how to add it to our current project, which is a hugo server serving static files.

jaiakash avatar Feb 10 '25 17:02 jaiakash

Hi, tagging @franciscojavierarceo @thesuperzapper @varodrig since this is inactive for last few days.

What do you all think of the above suggestion?

jaiakash avatar Feb 13 '25 18:02 jaiakash

I agree with @terrytangyuan , we probably shouldn't include stars from kubeflow/kubeflow. Otherwise, I'm good with the inclusion.

I do think having the links clickable to enable users to star the repo is useful but I understand that may not be ideal behavior.

franciscojavierarceo avatar Feb 20 '25 19:02 franciscojavierarceo

I have a slightly different opinion here. GitHub stars is a misleading metric and people often take it in the wrong way. Not a strong objection though.

If we do end up doing this, we should not include stars from kubeflow/kubeflow repo.

Same thoughts as @terrytangyuan

varodrig avatar Feb 21 '25 19:02 varodrig

/area website

varodrig avatar Mar 11 '25 02:03 varodrig