From 69e4968dbd5cb067782ea67f979ade958cf1481b Mon Sep 17 00:00:00 2001
From: Paul Gottschling <paul.gottschling@goteleport.com>
Date: Fri, 12 May 2023 16:47:19 -0400
Subject: [PATCH] Require capitalizing "Teleport" in the docs

Some parts of the docs say "teleport" where they should say "Teleport".
This change edits the messaging linter config to flag uses of "teleport"
that are not wrapped in backticks. The exception is in code comments and
descriptions, where backticks don't render.
---
 messaging-config.json | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/messaging-config.json b/messaging-config.json
index 5978b0ab4f..ad72c3a9d6 100644
--- a/messaging-config.json
+++ b/messaging-config.json
@@ -1,4 +1,10 @@
 [
+  {
+    "incorrect": "(?<!`)teleport(?!`)",
+    "correct": "`teleport` or Teleport",
+    "explanation": "capitalize \"Teleport\" unless you are describing the binary, in which case use code style",
+    "where": ["headers", "title", "body"]
+  },
   {
     "incorrect": "\\W(machine id|(database|app(lication)?|desktop|kubernetes|ssh|discovery) service)\\W",
     "correct": "capitalize the names of Teleport services",