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

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

Open
paravatha opened this issue Nov 15, 2023 · 17 comments
Open
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@paravatha
Copy link

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

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

@varodrig
Copy link
Contributor

@franciscojavierarceo
Copy link
Contributor

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

@varodrig
Copy link
Contributor

/help

Copy link

@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 google-oss-prow bot added the help wanted Extra attention is needed label Jan 27, 2025
@andreyvelich
Copy link
Member

/good-first-issue

Copy link

@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 google-oss-prow bot added the good first issue Good for newcomers label Jan 27, 2025
@jaiakash
Copy link
Contributor

jaiakash commented Jan 29, 2025

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
Copy link
Contributor

jaiakash commented Feb 1, 2025

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

@andreyvelich
Copy link
Member

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/

@jaiakash
Copy link
Contributor

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

@andreyvelich
Copy link
Member

Looks amazing @jaiakash.
WDYT @thesuperzapper ?

@jaiakash
Copy link
Contributor

jaiakash commented Feb 10, 2025

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

@thesuperzapper
Copy link
Member

@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 (Add dark theme to website #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
Copy link
Member

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.

@andreyvelich
Copy link
Member

I think, it is less important to have stars for kubeflow/kubeflow, since this repo won't have any projects after: kubeflow/kubeflow#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

@terrytangyuan
Copy link
Member

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.

@jaiakash
Copy link
Contributor

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 kubeflow/kubeflow#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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: To Do
Development

No branches or pull requests

7 participants