Improve version selector & rename "master" to "latest" #3863
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
thesuperzapper
force-pushed
the
rename-master-to-latest
branch
from
25c1068
to
05654f7
Compare
thesuperzapper
changed the title
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
Signed-off-by: Mathew Wicks <[email protected]>
|
@andreyvelich I have updated all the other PRs with the following changes:
|
|
We now need someone with GitHub org admin manually merge the following PRs:
|
|
@james-jwu or @zijianjoy can you please update these DNS records, as they don't point to our modern Netlify, so will not be updated otherwise:
|
|
@kubeflow/kubeflow-steering-committee @kubeflow/wg-pipeline-leads @kubeflow/wg-data-leads @kubeflow/wg-training-leads @kubeflow/wg-notebooks-leads @kubeflow/wg-manifests-leads Can you give +1 on the banner that @thesuperzapper proposed for the old docs ? If that looks good to you, we can start merging the PRs on the old website branches. |
|
@thesuperzapper Only one comment from me, that I don't think that we should add yellow banner on the 1.9 documentation, since it is the latest stable release.
WDYT @thesuperzapper ? |
@andreyvelich on the Kubernetes docs, "1.31" is actually a link to The problem is that we have already cut a In the future, I think we should hold off on cutting the 1.10 branch until just before we start merging docs for the 1.11 release. To resolve the current situation, we have two options:
|
|
"While that is nice in theory, it's a separate discussion to this as we currently don't support anything but 1.9.0." yes there is just not much capacity beyond that. This might change if someone volunteers. We only fix critical things that are easy to fix, so in practice it was around 1 Year for 1.8/1.8.1 and with 1.9.1 released 1.8.1 will be EOL for most developers. For longer support you probably need distributions, consultants etc. I like the term master more than latest, but I am also in favour of pushing for the master/latest version being shown by default and marking everything 2 releases away, so 1.8.1 and older as archived, snapshot, xxx End of Life or so. |
|
/lgtm I can see the dropdown and the version banner in the linked PRs, thank you! |
|
As we discussed during today's community call, we can manually squash + merge all PRs to disable indexing on old branches. |
* Block web crawlers on `v0.5-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]> * 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]> * Improve archived_version banner Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Mathew Wicks <[email protected]>
* Block web crawlers on `v0.6-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]> * Backport changes from #3863 Signed-off-by: Mathew Wicks <[email protected]> * Use correct site parameter for version selector name 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]> * Remove `Archive: ` version dropdown prefix Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Mathew Wicks <[email protected]>
* Block web crawlers on `v0.7-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]> * Try Node 12 Signed-off-by: Mathew Wicks <[email protected]> * Fix homepage buttons 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]> * Improve archived_version banner Signed-off-by: Mathew Wicks <[email protected]> * Remove `Archive: ` version dropdown prefix Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Mathew Wicks <[email protected]>
* 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]>
* 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]>
* 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]>
* 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]>
* 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]>
* 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]>
* 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]>
* 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]>
* 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]>
|
I've done the squash + merge. |
|
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 |
|
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. |
|
+1 for master rather than latest |
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:
"Latest", but in thev1.0-branchsnapshot it would be"Archive: 1.0"Archive:to each version labelScreenshots
OLD
NEW