[DOCS-15413] Add prodname shortcode BlockIgnore to Vale config - #39194
Draft
hestonhoffman wants to merge 1 commit into
Draft
[DOCS-15413] Add prodname shortcode BlockIgnore to Vale config#39194hestonhoffman wants to merge 1 commit into
hestonhoffman wants to merge 1 commit into
Conversation
Related to DOCS-15413.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Fixes DOCS-15413
Adds a
BlockIgnoreto.vale.iniso text already wrapped in theprodnameshortcode is skipped by the newDatadog.ProdnameVale rule (see datadog-vale#98), instead of being flagged again.This PR is a draft — remaining work on this branch includes running the new Vale rule against existing content and wrapping flagged product names in the
prodnameshortcode.Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Used Claude Code to draft the Vale rule design, the .vale.ini BlockIgnore, and this PR.
Additional notes