Improve searchability of redirect pages

GSA-TTS · Dec 12, 2024 · 557a76d · 557a76d
1 parent 5544a7b
commit 557a76d
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 65 deletions.
diff --git a/_articles/analytics-events.md b/_articles/analytics-events.md
@@ -1,6 +1,6 @@
 ---
 title: "Analytics Events"
-description: "`events.log` structure and event descriptions"
+description: Searchable list of IdP analytics events
 layout: article
 category: Reporting
 redirect_to: https://lg-public.pages.production.gitlab.login.gov/identity-internal-handbook/articles/analytics-events.html

diff --git a/_articles/incident-review-template.md b/_articles/incident-review-template.md
@@ -1,6 +1,6 @@
 ---
 title: "Incident Review Template"
-description:
+description: A template document for incident reviews, outlining causes, a timeline of events, and action items
 layout: article
 category: "Development"
 subcategory: Documentation

diff --git a/_articles/leave-guidance.md b/_articles/leave-guidance.md
@@ -1,5 +1,6 @@
 ---
 title: Leave Guidance
+description: Reasons, types, and conventions around taking leave as a Login.gov Login.gov employee
 layout: article
 category: Team
 subcategory: People Ops

diff --git a/_articles/offboarding.md b/_articles/offboarding.md
@@ -1,5 +1,6 @@
 ---
 title: "Offboarding"
+description: List of steps which must be completed when a person leaves the Login.gov program
 layout: article
 category: Team
 subcategory: People Ops

diff --git a/_articles/onboarding.md b/_articles/onboarding.md
@@ -1,5 +1,6 @@
 ---
 title: Onboarding
+description: List of steps to be completed when a person joins the Login.gov program
 layout: article
 category: Team
 subcategory: People Ops

diff --git a/_articles/orgchart.md b/_articles/orgchart.md
@@ -3,5 +3,6 @@ title: "Org Chart"
 layout: article
 category: "Team"
 subcategory: Team Organization
+description: Login.gov's roster of team members and teams
 redirect_to: https://docs.google.com/spreadsheets/d/1tiTR2ohdl0NIsrF4gJjNipEZ0z0oq1pOFWYjHg8Tbi0/edit#gid=0
 ---
diff --git a/_articles/overtime.md b/_articles/overtime.md
@@ -1,5 +1,6 @@
 ---
 title: Overtime
+description: Guidance around working overteam as a contractor or federal employee
 layout: article
 category: Team
 subcategory: People Ops

diff --git a/_articles/piv-ssh.md b/_articles/piv-ssh.md
diff --git a/_articles/platform-alerting.md b/_articles/platform-alerting.md
@@ -2,5 +2,6 @@
 title: "Infrastructure Metrics and Alerting"
 layout: article
 category: Platform
+description: Troubleshooting quick reference for infrastructure metrics and alerting, to analyze trends and track outages
 redirect_to: https://gitlab.login.gov/lg/identity-devops/-/wikis/Troubleshooting-Quick-Reference#infrastructure-metrics
 ---
diff --git a/_layouts/category.html b/_layouts/category.html
@@ -1,5 +1,6 @@
 ---
 layout: default
+exclude_from_index: true
 ---
 
 {% capture content_markdown %}

diff --git a/_layouts/default.html b/_layouts/default.html
@@ -15,7 +15,7 @@
     <meta name="MobileOptimized" content="320" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   </head>
-  <body {% unless page.exclude_from_index %}data-pagefind-body{% endunless %}>
+  <body {% unless page.exclude_from_index or layout.exclude_from_index %}data-pagefind-body{% endunless %}>
     <header class="usa-header usa-header--extended">
       <div class="usa-navbar">
         <div class="usa-logo">

diff --git a/_layouts/redirect.html b/_layouts/redirect.html
@@ -0,0 +1,24 @@
+---
+---
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Redirecting&hellip;</title>
+    <link rel="canonical" href="{{ page.redirect.to }}">
+    <script>location="{{ page.redirect.to }}"</script>
+    <meta http-equiv="refresh" content="0; url={{ page.redirect.to }}">
+    <meta name="robots" content="noindex">
+  </head>
+  <body>
+    <p>Redirecting&hellip;</p>
+    <a href="{{ page.redirect.to }}">Click here if you are not redirected.</a>
+
+    <div data-pagefind-body hidden>
+      <h1>{{ page.title }}</h1>
+      {% if page.description %}
+        <p>{{ page.description }}</p>
+      {% endif %}
+    </div>
+  </body>
+</html>
diff --git a/images/piv-macos-dialog.png b/images/piv-macos-dialog.png
diff --git a/spec/markdown_spec.rb b/spec/markdown_spec.rb
@@ -33,6 +33,8 @@ def category_exists?(title)
           expect(frontmatter).to be
 
           aggregate_failures do
+            expect(frontmatter['description']).to be
+
             category = frontmatter['category']
             expect(category).to be
             expect(category_exists?(category)).to be, "it links to a real category (#{category})"