From 4e5c1966eadd52d065eede8b5e260f14cb2d65b0 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/5] Block web crawlers on `v1.9-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 9ad9e6bef2..01c61d9b7e 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 -}} + + {{ partialCached "favicons.html" . }} From 68c2a9fb71a70a142223625767d5434b39aefeb9 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:57:00 -0700 Subject: [PATCH 2/5] Enable archived version header Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- config.toml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/config.toml b/config.toml index 3515860955..0b67b7e4fe 100644 --- a/config.toml +++ b/config.toml @@ -134,11 +134,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.9" # 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. @@ -146,7 +146,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"'. - github_branch = "master" + github_branch = "v1.9-branch" # Disable MathJax by default # NOTE: enable it per-page with `mathjax: true` in front matter @@ -157,6 +157,10 @@ enable = true version = "master" githubbranch = "master" url = "https://master.kubeflow.org" + [[params.versions]] + version = "v1.9" + githubbranch = "v1.9-branch" + url = "https://v1-9-branch.kubeflow.org" [[params.versions]] version = "v1.8" githubbranch = "v1.8-branch" From b5a7f1568d38e12b8dd133bdd4bed8b5caa5723d Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Wed, 4 Sep 2024 16:31:46 -0700 Subject: [PATCH 3/5] Backport changes from #3863 Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- config.toml | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/config.toml b/config.toml index 0b67b7e4fe..1243a3cd00 100644 --- a/config.toml +++ b/config.toml @@ -129,7 +129,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.9" # 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 @@ -142,7 +142,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"'. @@ -154,67 +154,67 @@ 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.9" + version = "Archive: 1.9" githubbranch = "v1.9-branch" url = "https://v1-9-branch.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 1a5e5cadc8d6ba8d2ae79ec65c1e8cfc1a04b499 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:44:29 -0700 Subject: [PATCH 4/5] Remove `Archive: ` version dropdown prefix Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- config.toml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/config.toml b/config.toml index 1243a3cd00..cca9660ad7 100644 --- a/config.toml +++ b/config.toml @@ -129,7 +129,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.9" + version_menu = "v1.9" # 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 @@ -158,63 +158,63 @@ enable = true githubbranch = "master" url = "https://www.kubeflow.org" [[params.versions]] - version = "Archive: 1.9" + version = "v1.9" githubbranch = "v1.9-branch" url = "https://v1-9-branch.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 cdae0e4f6117b33a90921f3513300331bc7ed174 Mon Sep 17 00:00:00 2001 From: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:45:09 -0700 Subject: [PATCH 5/5] 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 @@ +<!-- Check the variable that indicates whether this is an archived doc set. If yes, display a banner. --> +{{- $latest_version_url := .Site.Params.url_latest_version }} +{{- $current_version := replace .Site.Params.version "v" "" | markdownify }} +{{- if .Site.Params.archived_version }} + <style> + .version-banner { + padding: 1.5rem; + margin: 2rem 0; + max-width: 40rem; + border-style: solid; + border-color: #f0ad4e; + background-color: #faf5b6; + border-radius: 0.25rem; + } + .version-banner h3 { + margin-top: 0; + margin-bottom: 0.6em; + font-size: 1.25em; + } + .version-banner p { + margin-top: 0; + margin-bottom: 0; + } + </style> + <div class="version-banner"> + <h3>You are viewing documentation for <strong>Kubeflow {{ $current_version }}</strong></h3> + <p> + This is a static snapshot from the time of the Kubeflow {{ $current_version }} release. + <br> + For up-to-date information, see the <a href="{{ $latest_version_url | safeURL }}">latest version</a>. + </p> + </div> +{{- end }} \ No newline at end of file