Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require capitalizing "Teleport" in the docs #288

Closed
wants to merge 1 commit into from

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented May 12, 2023

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.

@vercel
Copy link

vercel bot commented May 12, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ❌ Failed (Inspect) Jul 25, 2023 10:28pm

@ptgott
Copy link
Contributor Author

ptgott commented May 12, 2023

Leaving this as a draft PR while I edit content files in gravitational/teleport to get this to pass

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.
@ptgott
Copy link
Contributor Author

ptgott commented Aug 9, 2023

I'm closing this because, after playing around with this approach, there are too many innocuous corner cases (e.g., teleport-kube-agent) for us to catch improper uses of the lowercased "teleport" using the messaging linter.

@ptgott ptgott closed this Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant