Add search index (#1777)

* Added search index for 2.15 docs Signed-off-by: Travis Beckham <[email protected]> * Tweaks Signed-off-by: Travis Beckham <[email protected]> * Added search index to robots.txt; Moved search index to root Signed-off-by: Travis Beckham <[email protected]> * Fixed deprecated .Site.IsServer Signed-off-by: Travis Beckham <[email protected]> * Removed unsused redirect output Signed-off-by: Travis Beckham <[email protected]> * Bumped Hugo version Signed-off-by: Travis Beckham <[email protected]> --------- Signed-off-by: Travis Beckham <[email protected]>
linkerd · May 17, 2024 · 9b214af · 9b214af
1 parent eb40950
commit 9b214af
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 19 deletions.
diff --git a/.devcontainer/on-create.sh b/.devcontainer/on-create.sh
@@ -5,7 +5,7 @@ set -euo pipefail
 cd $(mktemp -d)
 
 # hugo
-scurl -O https://github.com/gohugoio/hugo/releases/download/v0.121.2/hugo_extended_0.121.2_linux-amd64.deb
+scurl -O https://github.com/gohugoio/hugo/releases/download/v0.126.1/hugo_extended_0.126.1_linux-amd64.deb
 sudo dpkg -i hugo*.deb
 rm hugo*.deb
 

diff --git a/linkerd.io/content/_index.md b/linkerd.io/content/_index.md
@@ -5,8 +5,6 @@ description: Linkerd adds critical security, observability, and reliability to y
   Kubernetes stack, without any code changes.
 keywords:
 - cloud native applications
-outputs:
-- html
 top_hero:
   title: The world's most advanced service mesh
   description: Enterprise power *without* enterprise complexity. Linkerd adds

diff --git a/linkerd.io/hugo.toml b/linkerd.io/hugo.toml
@@ -2,7 +2,6 @@ ignoreErrors = ["error-remote-getjson"]
 paginate = 10
 baseurl = "https://linkerd.io/"
 disableKinds = ["taxonomy", "term"]
-enableRobotsTXT = true
 languageCode = "en-US"
 sectionPagesMenu = "main"
 theme = "buoyant"
@@ -85,14 +84,18 @@ title = "Linkerd"
   identifier = "join-forum"
   name = "Join Forum"
   url = "https://linkerd.buoyant.io"
-[outputFormats.REDIRECTS]
-  baseName = "_redirects"
-  mediaType = "text/netlify"
-[outputFormats.RSS]
-  mediatype = "application/RSS"
-  baseName = "feed"
+[outputFormats]
+  [outputFormats.REDIRECTS]
+    baseName = "_redirects"
+    mediaType = "text/netlify"
+  [outputFormats.RSS]
+    mediaType = "application/rss+xml"
+    baseName = "feed"
+  [outputFormats.SearchIndex]
+    mediaType = "application/json"
+    baseName = "search"
 [outputs]
-  home = ["HTML", "RSS", "REDIRECTS"]
+  home = ["HTML", "SearchIndex"]
   section = ["HTML", "RSS", "JSON"]
 [params]
   description = "Linkerd is an ultralight service mesh for Kubernetes. It gives you observability, reliability, and security without requiring any code changes."

diff --git a/linkerd.io/layouts/_default/baseof.html b/linkerd.io/layouts/_default/baseof.html
@@ -8,7 +8,7 @@
 </head>
 
 <body class="has-background-grey-light has-navbar-fixed-top ">
-  {{ if not .Site.IsServer }}
+  {{ if not hugo.IsServer }}
   <!-- Google Tag Manager (noscript) -->
   <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-PXBDGKJ" height="0" width="0"
       style="display:none;visibility:hidden"></iframe></noscript>

diff --git a/linkerd.io/layouts/index.searchindex.json b/linkerd.io/layouts/index.searchindex.json
@@ -0,0 +1,18 @@
+{{- $pages := where site.Pages "Section" "eq" "2.15" -}}
+[
+  {{- range $index, $page := $pages -}}
+    {{- if gt $index 0 -}} , {{- end -}}
+    {{- $ancestors := slice "linkerd.io" -}}
+    {{- range .Ancestors.Reverse -}}
+      {{- if .IsHome }}{{ continue }}{{ end -}}
+      {{- $ancestors = $ancestors | append .Title -}}
+    {{- end -}}
+    {{- $entry := dict "uri" $page.Permalink -}}
+    {{- $entry = merge $entry (dict "title" $page.Title) -}}
+    {{- $entry = merge $entry (dict "ancestors" $ancestors) -}}
+    {{- $entry = merge $entry (dict "content" ($page.Plain | htmlUnescape | truncate 3000)) -}}
+    {{- $entry = merge $entry (dict "description" $page.Description) -}}
+    {{- $entry = merge $entry (dict "keywords" $page.Keywords) -}}
+    {{- $entry | jsonify -}}
+  {{- end -}}
+]
diff --git a/linkerd.io/layouts/partials/css.html b/linkerd.io/layouts/partials/css.html
@@ -1,4 +1,4 @@
-{{ $inServerMode := site.IsServer }}
+{{ $inServerMode := hugo.IsServer }}
 {{ $useMaterial  := .Page.Params.use_material }}
 {{ if $useMaterial }}
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap-material-design/4.0.2/bootstrap-material-design.css" />

diff --git a/linkerd.io/static/robots.txt b/linkerd.io/static/robots.txt
@@ -0,0 +1,4 @@
+User-agent: *
+
+Disallow: https://slack.linkerd.io/
+Disallow: /search.json
diff --git a/linkerd.io/themes/buoyant/layouts/_default/baseof.html b/linkerd.io/themes/buoyant/layouts/_default/baseof.html
@@ -8,7 +8,7 @@
 </head>
 
 <body class="has-background-grey-light">
-  {{ if not .Site.IsServer }}
+  {{ if not hugo.IsServer }}
   <!-- Google Tag Manager (noscript) -->
   <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-PXBDGKJ" height="0" width="0"
       style="display:none;visibility:hidden"></iframe></noscript>

diff --git a/linkerd.io/themes/buoyant/layouts/partials/head.html b/linkerd.io/themes/buoyant/layouts/partials/head.html
@@ -21,7 +21,7 @@
 <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/lazysizes/4.1.5/lazysizes.min.js"></script>
 
-{{ if not .Site.IsServer }}
+{{ if not hugo.IsServer }}
 <!-- Google Tag Manager -->
 <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],

diff --git a/linkerd.io/themes/buoyant/layouts/robots.txt b/linkerd.io/themes/buoyant/layouts/robots.txt
diff --git a/netlify.toml b/netlify.toml
@@ -4,7 +4,7 @@ publish = "public"
 command = "make production-build"
 
 [build.environment]
-HUGO_VERSION = "0.119.0"
+HUGO_VERSION = "0.126.1"
 
 [context.deploy-preview]
 command = "make preview-build"