Block web crawlers on v1.3-branch (#3856)

* 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]>
kubeflow · Sep 12, 2024 · d2f4c8e · d2f4c8e
1 parent 40e4df0
commit d2f4c8e
Show file tree

Hide file tree

Showing 7 changed files with 1,710 additions and 62 deletions.
diff --git a/OWNERS b/OWNERS
@@ -1,16 +1,7 @@
 approvers:
-  - animeshsingh
-  - Bobgy
-  - joeliedtke
-  - RFMVasconcelos
-reviewers:
-  - 8bitmp3
-  - aronchick
-  - berndverst
-  - dansanche
-  - dsdinter
-  - Jeffwan
-  - jinchihe
-  - nickchase
-  - pdmack
+  - andreyvelich
+  - james-jwu
+  - jbottum
+  - johnugeorge
   - terrytangyuan
+  - zijianjoy
diff --git a/config.toml b/config.toml
@@ -124,11 +124,11 @@ version = "v1.3"
 
 # 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.
-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"'.
@@ -137,59 +137,45 @@ githubbranch = "v1.3-branch"
 # Add new release versions here. 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"
-
-[[params.versions]]
-  version = "v0.2"
-  githubbranch = "v0.2-branch"
-  url = "https://v0-2.kubeflow.org"
-
+  url = "https://www.kubeflow.org"
 [[params.versions]]
-  version = "v0.3"
-  githubbranch = "v0.3-branch"
-  url = "https://v0-3.kubeflow.org"
-
+  version = "v1.3"
+  githubbranch = "v1.3-branch"
+  url = "https://v1-3-branch.kubeflow.org"
 [[params.versions]]
-  version = "v0.4"
-  githubbranch = "v0.4-branch"
-  url = "https://v0-4.kubeflow.org"
-
+  version = "v1.2"
+  githubbranch = "v1.2-branch"
+  url = "https://v1-2-branch.kubeflow.org"
 [[params.versions]]
-  version = "v0.5"
-  githubbranch = "v0.5-branch"
-  url = "https://v0-5.kubeflow.org"
-
+  version = "v1.1"
+  githubbranch = "v1.1-branch"
+  url = "https://v1-1-branch.kubeflow.org"
 [[params.versions]]
-  version = "v0.6"
-  githubbranch = "v0.6-branch"
-  url = "https://v0-6.kubeflow.org"
-
+  version = "v1.0"
+  githubbranch = "v1.0-branch"
+  url = "https://v1-0-branch.kubeflow.org"
 [[params.versions]]
   version = "v0.7"
   githubbranch = "v0.7-branch"
   url = "https://v0-7.kubeflow.org"
-
 [[params.versions]]
-  version = "v1.0"
-  githubbranch = "v1.0-branch"
-  url = "https://v1-0-branch.kubeflow.org"
-
+  version = "v0.6"
+  githubbranch = "v0.6-branch"
+  url = "https://v0-6.kubeflow.org"
 [[params.versions]]
-  version = "v1.1"
-  githubbranch = "v1.1-branch"
-  url = "https://v1-1-branch.kubeflow.org"
-
+  version = "v0.5"
+  githubbranch = "v0.5-branch"
+  url = "https://v0-5.kubeflow.org"
 [[params.versions]]
-  version = "v1.2"
-  githubbranch = "v1.2-branch"
-  url = "https://v1-2-branch.kubeflow.org"
-
+  version = "v0.4"
+  githubbranch = "v0.4-branch"
+  url = "https://v0-4.kubeflow.org"
 [[params.versions]]
-  version = "v1.3"
-  githubbranch = "v1.3-branch"
-  url = "https://v1-3-branch.kubeflow.org"
+  version = "v0.3"
+  githubbranch = "v0.3-branch"
+  url = "https://v0-3.kubeflow.org"
 
 # Docsy: User interface configuration
 [params.ui]

diff --git a/layouts/partials/head.html b/layouts/partials/head.html
@@ -1,11 +1,8 @@
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 {{ hugo.Generator }}
-{{ if eq (getenv "HUGO_ENV") "production" }}
-<META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
-{{ else }}
-<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
-{{ end }}
+<!-- Prevent search engines from indexing this old site -->
+<meta name="robots" content="noindex">
 {{ range .AlternativeOutputFormats -}}
 <link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}">
 {{ end -}}

diff --git a/layouts/partials/version-banner.html 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 }}
diff --git a/netlify.toml b/netlify.toml
@@ -4,10 +4,13 @@
 
 [context.deploy-preview.environment]
   HUGO_VERSION = "0.87.0"
+  NODE_VERSION = "16"
 
 [context.production.environment]
   HUGO_VERSION = "0.87.0"
+  NODE_VERSION = "16"
   HUGO_ENV = "production"
 
 [context.branch-deploy.environment]
-  HUGO_VERSION = "0.87.0"
+  HUGO_VERSION = "0.87.0"
+  NODE_VERSION = "16"