Skip to content

Improve version selector & rename "master" to "latest" #3863

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

Closed

Conversation

thesuperzapper
Copy link
Member

@thesuperzapper thesuperzapper commented Sep 4, 2024

In the top right of the website, we have a "version selector" that lets you view archived versions of the docs from past releases, however, the current presentation is confusing to users.

New users expect that they should browse the site on the 1.9 branch for information about 1.9 (when in reality they should browse the master branch because we are always updating it).

In reality, we treat these historical snapshot versions as "snapshot archives" and don't go back to update them with content from master.

This PR makes the following changes to the version menu:

  • Renamed the button which you click to expand the menu:
    • For example, in this PR its "Latest", but in the v1.0-branch snapshot it would be "Archive: 1.0"
  • prepended Archive: to each version label
  • removes versions older than 0.6 from the dropdown

Screenshots

OLD

Screenshot 2024-09-04 at 17 58 06

NEW

Screenshot 2024-10-15 at 09 00 03

thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
@thesuperzapper thesuperzapper force-pushed the rename-master-to-latest branch from 25c1068 to 05654f7 Compare September 4, 2024 23:34
@thesuperzapper thesuperzapper changed the title Improve "Docs Version" selector + rename "master" to "latest" Improve version selector & rename "master" to "latest" Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 4, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 5, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 5, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 5, 2024
thesuperzapper added a commit to thesuperzapper/website that referenced this pull request Sep 5, 2024
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.0-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Update Hugo to 0.81.0

Signed-off-by: Mathew Wicks <[email protected]>

* Add missing `package.json` for Netlify

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.1-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Update Hugo to 0.81.0

Signed-off-by: Mathew Wicks <[email protected]>

* Add missing `package.json` for Netlify

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.3-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Add missing `package.json` for Netlify

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.2-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Update Hugo to 0.81.0

Signed-off-by: Mathew Wicks <[email protected]>

* Add missing `package.json` for Netlify

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.4-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Add missing `package.json` for Netlify

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.5-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Fix archived version warning

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.6-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.7-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
james-jwu pushed a commit that referenced this pull request Sep 12, 2024
* Block web crawlers on `v1.8-branch`

Signed-off-by: Mathew Wicks <[email protected]>

* Enable archived version header

Signed-off-by: Mathew Wicks <[email protected]>

* Backport changes from #3863

Signed-off-by: Mathew Wicks <[email protected]>

* Align OWNERS to `master` branch

Signed-off-by: Mathew Wicks <[email protected]>

* Remove `Archive: ` version dropdown prefix

Signed-off-by: Mathew Wicks <[email protected]>

* Improve archived_version banner

Signed-off-by: Mathew Wicks <[email protected]>

---------

Signed-off-by: Mathew Wicks <[email protected]>
@james-jwu
Copy link

I've done the squash + merge.

@zijianjoy
Copy link
Contributor

Both the DNS configuration and the Kubeflow website hosting on Netlify are transferred to CNCF. Would you like to make a request to CNCF by submitting a service deck ticket? https://cncfservicedesk.atlassian.net/servicedesk/customer/portals

@jbottum
Copy link
Contributor

jbottum commented Oct 4, 2024

it seems like there are several activities in this PR. I am a -1 on the initial proposal to change from master, 1.9. i.e. I am -1 on latest and archive proposal.

@jbottum
Copy link
Contributor

jbottum commented Nov 12, 2024

+1 for master rather than latest

Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Copy link

github-actions bot commented Mar 9, 2025

This pull request has been automatically closed because it has not had recent activity.You can reopen the PR if you want.

@github-actions github-actions bot closed this Mar 9, 2025
@thesuperzapper
Copy link
Member Author

We still need to decide what to do here regarding "master", but the "archived message" update from this PR is still important for when we branch off future release branches (and set the archived flag to true).

/reopen

@google-oss-prow google-oss-prow bot reopened this Mar 10, 2025
Copy link

@thesuperzapper: Reopened this PR.

In response to this:

We still need to decide what to do here regarding "master", but the "archived message" update from this PR is still important for when we branch off future release branches (and set the archived flag to true).

/reopen

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.

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 franciscojavierarceo 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

@juliusvonkohout
Copy link
Member

+1 for master rather than latest

This is also my opinion.

@varodrig
Copy link
Contributor

varodrig commented Mar 11, 2025

My opinion is to not use master,
as github renamed master to main https://github.com/github/renaming why it was renamed https://www.theserverside.com/feature/Why-GitHub-renamed-its-master-branch-to-main even thought this in terms of branching, I prefer not to use master.

Is there an option to do something like kubernetes does for their versioning? only showing the release numbers?

image
https://kubernetes.io/releases/

@thesuperzapper
Copy link
Member Author

closing in favor of one that just updates the norobots meta tag template: #4119

/close

@google-oss-prow google-oss-prow bot closed this May 27, 2025
Copy link

@thesuperzapper: Closed this PR.

In response to this:

closing in favor of one that just updates the norobots meta tag template: #4119

/close

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.

10 participants