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 version popout to "Packaged Distributions" table #3842

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

thesuperzapper
Copy link
Member

@thesuperzapper thesuperzapper commented Aug 23, 2024

This PR improves the "Packaged Distributions" table by making it clearer how old/new each Kubeflow Version is. Right now, it's very confusing to new users, as they might not know that Kubeflow 1.7 is actually very old (released in March 2023), so they might start the process of adopting a long-abandoned distribution.

The key changes this PR makes are:

  1. In the "Packaged Distributions" table under the "Kubeflow Version" column:
    • Put a hover-able icon that says how long ago that version of Kubeflow was released. (Note, this is the Kubeflow released date, not the release date of the distribution).
    • Highlight distributions which are up to date (within 1 minor version of the latest), and de-emphasize distributions which are 2+ minor versions out of date.
    • Place warning icons beside versions which are very old (2 = warning, 3+ = scull)
  2. Remove the very old link to the historical "conformance program" which was started by google but never continued.

Please note, all of the styling is automatic:

  • when the short-codes for that distribution's version are updated everything will change automatically
  • when we release a new version of Kubeflow, can use the content/en/docs/started/installing-kubeflow/get_new_releases.sh to cache that version's release date into the content/en/docs/started/installing-kubeflow/release-info folder of JSON (the build will fail to remind you if you try referencing a version which it does not know about)

Screenshots

OLD

Screenshot 2024-08-23 at 15 30 56

NEW

Table Overview

Screenshot 2024-08-23 at 15 31 13

On-Hover ("Latest Version")

Screenshot 2024-08-23 at 15 33 03

On-Hover ("1 from Latest Version")

Screenshot 2024-08-23 at 15 36 09

On-Hover ("2 from Latest Version")

Screenshot 2024-08-23 at 15 34 07

On-Hover ("3+ from Latest Version")

Screenshot 2024-08-23 at 15 34 55

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign james-jwu for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@thesuperzapper
Copy link
Member Author

@jbottum @andreyvelich @kimwnasptd @terrytangyuan @ederign please take a look at this important style update to the "Packaged Distributions" table.

It should help avoid confusion with new users about which distributions are currently supported.
See the preview site here:

@juliusvonkohout
Copy link
Member

The screenshots look good to me.

@thesuperzapper thesuperzapper force-pushed the add-version-popout-to-distribution-table branch from 27ec59f to baecd28 Compare August 28, 2024 17:41
@jbottum
Copy link
Contributor

jbottum commented Sep 3, 2024

Since this impacts how distributions are promoted, my suggestion is that it would be good if a majority of the distribution owners approved this i.e. we need 6 distributions to provide a +1 or lgtm

@terrytangyuan
Copy link
Member

/cc @kubeflow/kubeflow-steering-committee
/hold

Copy link

@terrytangyuan: GitHub didn't allow me to request PR reviews from the following users: kubeflow/kubeflow-steering-committee.

Note that only kubeflow members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @kubeflow/kubeflow-steering-committee
/hold

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.

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.

4 participants