Skip to content

Commit

Permalink
Require capitalizing "Teleport" in the docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ptgott committed May 12, 2023
1 parent c0b7eb7 commit 69e4968
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions messaging-config.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 69e4968

Please sign in to comment.