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

Messaging linter does not check lists #334

Open
ptgott opened this issue Jul 6, 2023 · 0 comments
Open

Messaging linter does not check lists #334

ptgott opened this issue Jul 6, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@ptgott
Copy link
Contributor

ptgott commented Jul 6, 2023

Let's say you have the following Markdown in a docs page:

---
title: Test Page
description: test page
---

This is a list:
1. This item has to do with the application service
2. This item has to do with the database service

This paragraph has to do with the kubernetes service.

The messaging linter—which checks whether the docs use Teleport terms correctly—will only catch "kubernetes service", not "application service" and "database service". We should extend the messaging linter to catch issues within lists (both ordered and unordered), and treat lists as part of the document body (you can configure the messaging linter to only check for errors in the title, description, headers, body, or code comments).

@ptgott ptgott added the bug Something isn't working label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant