Optimized SEO for Guides (#1090)

Dgiordano33 · Dan G · web-flow · commit 5709bff64ee3 · 2024-10-17T21:13:56.000-04:00
* guide SEO optimization

* redirects for Guides

---------

Co-authored-by: Dan G &lt;danielgiordano@Daniels-MacBook-Pro.local&gt;
diff --git a/site/content/guides/end-to-end-monitoring.md b/site/content/guides/end-to-end-monitoring.md
@@ -1,20 +1,20 @@
 ---
-title: What is End to End Monitoring? Overview with Examples
-displayTitle: End to end monitoring
+title: What is End to End Monitoring? An Overview with Examples
+displayTitle: What is End to End Monitoring?
 description: >-
   Learn end-to-end monitoring with playwright to test key website flows. Follow our guide that gets you up and running in 10 minutes.
 author: Giovanni Rago
 avatar: 'images/avatars/giovanni-rago.png'
 ---
-## What is end-to-end monitoring?
+## An overview of end-to-end monitoring
 
 End-to-end monitoring is a comprehensive strategy designed to assess the overall health and performance of a service by examining the entire lifecycle of requests to an application. By simulating a user request, including the browser rendering and user experience, an operations or development professional tests all parts of an application at once; hence the name ‘end-to-end.’ End-to-end monitoring is an outgrowth of end-to-end testing, where rather than sending test request once, with monitoring tests are run on a cadence, and the results automatically compiled.
 
 By aligning monitoring insights with the user experience, end-to-end monitoring ensures that any anomalies, edge cases, or potential failures impacting users are quickly identified and addressed. 
 
 This inclusive monitoring strategy often involves multiple teams, including developers, network engineers, and non-technical stakeholders, fostering a collaborative effort to maintain optimal system performance and enhance the digital experience for users.
 
-### End-to-end monitoring vs traditional monitoring approaches
+## End-to-end monitoring vs traditional monitoring approaches
 
 Unlike traditional testing, which focuses on isolated components and only tests occasionally, end-to-end monitoring provides a holistic view of a product or service.
 
diff --git a/site/content/guides/monitoring-an-openapi-spec.md b/site/content/guides/monitoring-an-openapi-spec.md
@@ -1,12 +1,12 @@
 ---
-title: OpenAPI/Swagger Monitoring
+title: How to create an API monitor using an OpenAPI (Swagger) spec
 description: >-
   OpenAPI and Swagger help users design and document APIs in a way that is readable from both humans and machines. As a consequence, they can also be used to generate the code that will run the specified API - both on the provider and consumer side. Can we leverage this same principle to simplify API monitoring? After a brief first look at OpenAPI and Swagger, this article will show how we can quickly use them to monitor a new or existing API.
 author: Giovanni Rago
 avatar: 'images/avatars/giovanni-rago.png'
 ---
 
-## The OpenAPI Specification
+## What is the OpenAPI Specification?
 
 The {{< newtabref  href="https://spec.openapis.org/oas/v3.1.0" title="OpenAPI Specification (OAS)" >}} specifies a standard, language-agnostic and machine-readable format to describe a web API in one or more files. Nowadays, it acts as a vendor-neutral standard for describing the structure and behaviour of HTTP-based APIs, and exists as part of the {{< newtabref  href="https://www.openapis.org/" title="OpenAPI Initiative (OAI)" >}}.
 
diff --git a/site/content/guides/monitoring-ecommerce-apps-using-playwright.md b/site/content/guides/monitoring-ecommerce-apps-using-playwright.md
@@ -1,8 +1,6 @@
 ---
-title: What is End to End Monitoring? Overview with Examples
-displayTitle: Monitoring as code with the Checkly CLI
-metatags:
-  title: What is End to End Monitoring? Overview with Examples
+title: How to monitor your e-commerce site with Playwright
+displayTitle: How to monitor your e-commerce site with Playwright
 description: Discover how Monitoring as Code transforms cloud infrastructure management with a hands-on Checkly case study. Start optimizing your workflow today!
 displayDescription: >-
   The as code movement has been picking up steam over the last few years, offering a way for DevOps teams to transparently manage and scale cloud infrastructure, security and other resources. Why should the way we manage monitoring be any different? In this article, we address this point and illustrate it with a practical example of monitoring as code (MaC) via our Checkly CLI.
diff --git a/site/content/guides/monitoring-ecommerce-apps-using-terraform.md b/site/content/guides/monitoring-ecommerce-apps-using-terraform.md
@@ -1,10 +1,7 @@
 ---
-title: Monitoring as code
+title: How to monitor your e-commerce application using Terraform
 description: >-
   The trend of declaring infrastructure as code has been picking up steam over the last few years, offering a way for DevOps teams to transparently manage and scale cloud infrastructure. Why should the way we manage monitoring be any different? In this article, we address this point and illustrate it with a practical example of Monitoring-as-Code on Checkly.
-metatags:
-  title: "Monitoring as Code: Guide to Code Monitoring With Checkly"
-  description: "Discover how Monitoring as Code transforms cloud infrastructure management with a hands-on Checkly case study. Start optimizing your workflow today!"
 author: Giovanni Rago
 avatar: 'images/avatars/giovanni-rago.png'
 ---
diff --git a/site/content/guides/monitoring-the-stripe-api.md b/site/content/guides/monitoring-the-stripe-api.md
@@ -1,5 +1,6 @@
 ---
-title: API Monitoring for the Jamstack
+title: How to monitor the Stripe customer API with Checkly | API Monitoring Examples
+displayTitle: How to monitor the Stripe customer API with Checkly
 description: >-
   Application Programming Interfaces (APIs) are used throughout software to define interactions between different software applications. In this article we focus on web APIs specifically, taking a look at how they fit in the Jamstack architecture and how we can set up API monitoring in order to make sure they don't break and respond fast.
 author: Giovanni Rago
@@ -8,7 +9,7 @@ avatar: 'images/avatars/giovanni-rago.png'
 
 {{< figure src="/guides/images/guides-checkly-jamstack-header.png" alt="jamstack architecture diagram" title="Jamstack applications heavily rely on APIs" >}}
 
-## APIs and the Jamstack
+## The rise of APIs
 
 With the rise of the {{< newtabref  href="https://jamstack.org/" title="Jamstack" >}}, the already broadly used web APIs have been brought further into the spotlight and explicitly named as cornerstone of a new way of building web applications. In the Jamstack paradigm, applications rely on APIs returning structured data (JSON or XML) when queried via a build process or Javascript-based frontend.
 
diff --git a/site/content/guides/moving-from-puppeteer-to-playwright.md b/site/content/guides/moving-from-puppeteer-to-playwright.md
@@ -1,5 +1,5 @@
 ---
-title: Migrating from Puppeteer to Playwright
+title: The Complete Guide to Migrating from Puppeteer to Playwright
 description: >-
   The switch from Puppeteer to Playwright is easy. But is it worth it? And how exactly does one migrate existing scripts from one tool to another? What are the required code-level changes, and what new features and approaches does the switch enable?
 author: Giovanni Rago
diff --git a/site/content/guides/setup-scripts-for-apis.md b/site/content/guides/setup-scripts-for-apis.md
@@ -1,5 +1,6 @@
 ---
-title: Setup scripts for API monitoring
+title: How to use setup scripts for better API monitoring
+displayTitle: How to use setup scripts for better API monitoring
 description: >-
   Setup scripts are a fundamental tool to tailor API checks to your own target endpoints. Their power and flexibility can intimidate beginners, who might struggle to understand how the different parts fit together. This guide will present and break down different real-world examples to help you master this game-changing tool.
 author: Giovanni Rago
diff --git a/site/content/guides/the-programmable-monitoring-platform.md b/site/content/guides/the-programmable-monitoring-platform.md
@@ -1,5 +1,5 @@
 ---
-title: Monitoring as code — the programmable monitoring platform
+title: A Guide to Checkly — The Programmable Monitoring Platform
 description: >-
   The monitoring as code workflow enables developers to code, test and deploy your entire monitoring infrastructure. This guide explains how to leverage TypeScript/JavaScript to configure your monitoring setup dynamically.
 author: Stefan Judis
diff --git a/site/layouts/guides/list.html b/site/layouts/guides/list.html
@@ -25,8 +25,7 @@ <h2><a href="{{ .RelPermalink }}">
 						</div>
 						<div class="write-info">
 							<img src="{{ .Params.avatar | relURL }}" alt="{{ .Params.author }}"  width="24" height="24" />
-							<span>{{ .Params.author }} last update </span>
-							<time>{{ .Lastmod.Format "2 Jan 2006" }}</time>
+							<span>{{ .Params.author }} </span>
 							<a href="{{ .RelPermalink }}" class="cta-link">Read the guide</a>
 						</div>
 					</div>
diff --git a/site/layouts/guides/single.html b/site/layouts/guides/single.html
@@ -3,7 +3,7 @@
     <div class="guides-page">
       <div class="col-sm-12 col-lg-11">
       	<div class="guides__label">
-      		Checkly Guides
+      		<a href="/guides/">Checkly Guides</a>
       	</div>
       	<h1 class="guides__title">
           {{ if .Params.displayTitle}}
@@ -25,6 +25,10 @@ <h1 class="guides__title">
           {{end}}
         </p>
       	{{ end }}
+        <div class="write-info">
+          <img src="{{ .Params.avatar | relURL }}" alt="{{ .Params.author }}"  width="24" height="24" />
+          <span>{{ .Params.author }} </span>
+        </div>
         <span class="markdown">{{.Content}}</span>
       </div>
     </div>
diff --git a/vercel.json b/vercel.json
@@ -82,6 +82,12 @@
     { "source": "/learn/playwright/intercept-request(/)?", "destination": "/learn/playwright/intercept-requests/", "permanent": true },
     { "source": "/learn/playwright/interaction/waits(/)?", "destination": "/learn/playwright/waits-and-timeouts/", "permanent": true },
     { "source": "/learn/headless/basics-puppeteer-intro(/)?", "destination": "/learn/playwright/", "permanent": true },
-    { "source": "/learn/headless(/)?", "destination": "/learn/playwright/", "permanent": true }
+    { "source": "/learn/headless(/)?", "destination": "/learn/playwright/", "permanent": true },
+    { "source": "/guides/api-monitoring(/)?", "destination": "/guides/monitoring-the-stripe-api/", "permanent": true },
+    { "source": "/guides/puppeteer-to-playwright(/)?", "destination": "/guides/moving-from-puppeteer-to-playwright/", "permanent": true },
+    { "source": "/guides/monitoring-as-code-cli(/)?", "destination": "/guides/monitoring-ecommerce-apps-using-playwright/", "permanent": true },
+    { "source": "/guides/monitoring-as-code(/)?", "destination": "/guides/monitoring-ecommerce-apps-using-terraform/", "permanent": true },
+    { "source": "/guides/setup-scripts(/)?", "destination": "/guides/setup-scripts-for-apis/", "permanent": true },
+    { "source": "/guides/openapi-swagger(/)?", "destination": "/guides/monitoring-an-openapi-spec/", "permanent": true }
   ]
 }
