From 246da0140b89f3c96026e732644852ad95c64f7d Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:50:01 -0700 Subject: [PATCH 1/6] Block web crawlers on `v1.8-branch` Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- layouts/partials/head.html | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/layouts/partials/head.html b/layouts/partials/head.html index 735944195e..8cd6549fcd 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -5,12 +5,8 @@ {{ end -}} -{{ $outputFormat := partial "outputformat.html" . -}} -{{ if and hugo.IsProduction (ne $outputFormat "print") -}} - -{{ else -}} - -{{ end -}} + + {{ partial "seo_schema" . }} From 49ad8262158ce8b3ef93c0a3b05a9a507ca659c7 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:50:47 -0700 Subject: [PATCH 2/6] Enable archived version header Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- config.toml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/config.toml b/config.toml index b557289946..a1f0da13a2 100644 --- a/config.toml +++ b/config.toml @@ -118,11 +118,11 @@ enable = true # The major.minor version tag for the version of the docs represented in this # branch of the repository. Used in the "version-banner" partial to display a # version number for this doc set. - version = "master" + version = "v1.8" # Flag used in the "version-banner" partial to decide whether to display a # banner on every page indicating that this is an archived version of the docs. - archived_version = false + archived_version = true # A link to latest version of the docs. Used in the "version-banner" partial to # point people to the main doc site. @@ -130,7 +130,7 @@ enable = true # A variable used in various docs to determine URLs for config files etc. # To find occurrences, search the repo for 'params "githubbranch"'. - githubbranch = "master" + githubbranch = "v1.8-branch" # These entries appear in the drop-down menu at the top of the website. [[params.versions]] From 121506b03b0d7dab546cbc89c6a9f0a400cfac7b Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Wed, 4 Sep 2024 16:41:22 -0700 Subject: [PATCH 3/6] Backport changes from #3863 Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- config.toml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/config.toml b/config.toml index a1f0da13a2..9279eea439 100644 --- a/config.toml +++ b/config.toml @@ -113,7 +113,7 @@ enable = true gcs_engine_id = "007239566369470735695:624rglujm-w" # Text label for the version menu in the top bar of the website. - version_menu = "Kubeflow Version" + version_menu = "Archive: 1.8" # The major.minor version tag for the version of the docs represented in this # branch of the repository. Used in the "version-banner" partial to display a @@ -126,7 +126,7 @@ enable = true # A link to latest version of the docs. Used in the "version-banner" partial to # point people to the main doc site. - url_latest_version = "https://kubeflow.org/docs/" + url_latest_version = "https://www.kubeflow.org/docs/" # A variable used in various docs to determine URLs for config files etc. # To find occurrences, search the repo for 'params "githubbranch"'. @@ -134,63 +134,63 @@ enable = true # These entries appear in the drop-down menu at the top of the website. [[params.versions]] - version = "master" + version = "Latest" githubbranch = "master" - url = "https://master.kubeflow.org" + url = "https://www.kubeflow.org" [[params.versions]] - version = "v1.8" + version = "Archive: 1.8" githubbranch = "v1.8-branch" url = "https://v1-8-branch.kubeflow.org" [[params.versions]] - version = "v1.7" + version = "Archive: 1.7" githubbranch = "v1.7-branch" url = "https://v1-7-branch.kubeflow.org" [[params.versions]] - version = "v1.6" + version = "Archive: 1.6" githubbranch = "v1.6-branch" url = "https://v1-6-branch.kubeflow.org" [[params.versions]] - version = "v1.5" + version = "Archive: 1.5" githubbranch = "v1.5-branch" url = "https://v1-5-branch.kubeflow.org" [[params.versions]] - version = "v1.4" + version = "Archive: 1.4" githubbranch = "v1.4-branch" url = "https://v1-4-branch.kubeflow.org" [[params.versions]] - version = "v1.3" + version = "Archive: 1.3" githubbranch = "v1.3-branch" url = "https://v1-3-branch.kubeflow.org" [[params.versions]] - version = "v1.2" + version = "Archive: 1.2" githubbranch = "v1.2-branch" url = "https://v1-2-branch.kubeflow.org" [[params.versions]] - version = "v1.1" + version = "Archive: 1.1" githubbranch = "v1.1-branch" url = "https://v1-1-branch.kubeflow.org" [[params.versions]] - version = "v1.0" + version = "Archive: 1.0" githubbranch = "v1.0-branch" url = "https://v1-0-branch.kubeflow.org" [[params.versions]] - version = "v0.7" + version = "Archive: 0.7" githubbranch = "v0.7-branch" url = "https://v0-7.kubeflow.org" [[params.versions]] - version = "v0.6" + version = "Archive: 0.6" githubbranch = "v0.6-branch" url = "https://v0-6.kubeflow.org" [[params.versions]] - version = "v0.5" + version = "Archive: 0.5" githubbranch = "v0.5-branch" url = "https://v0-5.kubeflow.org" [[params.versions]] - version = "v0.4" + version = "Archive: 0.4" githubbranch = "v0.4-branch" url = "https://v0-4.kubeflow.org" [[params.versions]] - version = "v0.3" + version = "Archive: 0.3" githubbranch = "v0.3-branch" url = "https://v0-3.kubeflow.org" From 1c72591240929f47c2677d04118b56696273a79b Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:40:29 -0700 Subject: [PATCH 4/6] Align OWNERS to `master` branch Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- OWNERS | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/OWNERS b/OWNERS index 3df8e780f8..dad6adc133 100644 --- a/OWNERS +++ b/OWNERS @@ -1,18 +1,7 @@ approvers: - - animeshsingh - - chensun + - andreyvelich - james-jwu - - knkski - - shannonbradshaw - - zijianjoy -reviewers: - - 8bitmp3 - - aronchick - - berndverst - - dansanche - - dsdinter - - Jeffwan - - jinchihe - - nickchase - - pdmack + - jbottum + - johnugeorge - terrytangyuan + - zijianjoy \ No newline at end of file From 3966d2431b230ecc778bba63a59ac9cfb779d163 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:40:44 -0700 Subject: [PATCH 5/6] Remove `Archive: ` version dropdown prefix Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- config.toml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/config.toml b/config.toml index 9279eea439..e4b177c7b8 100644 --- a/config.toml +++ b/config.toml @@ -113,7 +113,7 @@ enable = true gcs_engine_id = "007239566369470735695:624rglujm-w" # Text label for the version menu in the top bar of the website. - version_menu = "Archive: 1.8" + version_menu = "v1.8" # The major.minor version tag for the version of the docs represented in this # branch of the repository. Used in the "version-banner" partial to display a @@ -138,59 +138,59 @@ enable = true githubbranch = "master" url = "https://www.kubeflow.org" [[params.versions]] - version = "Archive: 1.8" + version = "v1.8" githubbranch = "v1.8-branch" url = "https://v1-8-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.7" + version = "v1.7" githubbranch = "v1.7-branch" url = "https://v1-7-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.6" + version = "v1.6" githubbranch = "v1.6-branch" url = "https://v1-6-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.5" + version = "v1.5" githubbranch = "v1.5-branch" url = "https://v1-5-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.4" + version = "v1.4" githubbranch = "v1.4-branch" url = "https://v1-4-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.3" + version = "v1.3" githubbranch = "v1.3-branch" url = "https://v1-3-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.2" + version = "v1.2" githubbranch = "v1.2-branch" url = "https://v1-2-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.1" + version = "v1.1" githubbranch = "v1.1-branch" url = "https://v1-1-branch.kubeflow.org" [[params.versions]] - version = "Archive: 1.0" + version = "v1.0" githubbranch = "v1.0-branch" url = "https://v1-0-branch.kubeflow.org" [[params.versions]] - version = "Archive: 0.7" + version = "v0.7" githubbranch = "v0.7-branch" url = "https://v0-7.kubeflow.org" [[params.versions]] - version = "Archive: 0.6" + version = "v0.6" githubbranch = "v0.6-branch" url = "https://v0-6.kubeflow.org" [[params.versions]] - version = "Archive: 0.5" + version = "v0.5" githubbranch = "v0.5-branch" url = "https://v0-5.kubeflow.org" [[params.versions]] - version = "Archive: 0.4" + version = "v0.4" githubbranch = "v0.4-branch" url = "https://v0-4.kubeflow.org" [[params.versions]] - version = "Archive: 0.3" + version = "v0.3" githubbranch = "v0.3-branch" url = "https://v0-3.kubeflow.org" From 638e384afd4251ccd2b9fbe90efd57c670824bb1 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:40:53 -0700 Subject: [PATCH 6/6] Improve archived_version banner Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- layouts/partials/version-banner.html | 33 ++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 layouts/partials/version-banner.html diff --git a/layouts/partials/version-banner.html b/layouts/partials/version-banner.html new file mode 100644 index 0000000000..641e73fdc8 --- /dev/null +++ b/layouts/partials/version-banner.html @@ -0,0 +1,33 @@ + +{{- $latest_version_url := .Site.Params.url_latest_version }} +{{- $current_version := replace .Site.Params.version "v" "" | markdownify }} +{{- if .Site.Params.archived_version }} + +
+

You are viewing documentation for Kubeflow {{ $current_version }}

+

+ This is a static snapshot from the time of the Kubeflow {{ $current_version }} release. +
+ For up-to-date information, see the latest version. +

+
+{{- end }} \ No newline at end of file