Add frontmatter warning for mapped_pages edits#141
Merged
Conversation
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/1430eb4b-2fd3-4e75-a59e-cb13f4962ab5 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/1430eb4b-2fd3-4e75-a59e-cb13f4962ab5 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/1430eb4b-2fd3-4e75-a59e-cb13f4962ab5 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/1430eb4b-2fd3-4e75-a59e-cb13f4962ab5 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/1430eb4b-2fd3-4e75-a59e-cb13f4962ab5 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/1430eb4b-2fd3-4e75-a59e-cb13f4962ab5 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Introduce rule to warn on changes to mapped_pages in documentation
Add frontmatter warning for May 11, 2026
mapped_pages edits
bmorelli25
reviewed
May 13, 2026
bmorelli25
reviewed
May 13, 2026
Agent-Logs-Url: https://github.com/elastic/vale-rules/sessions/37a03f3e-8883-4568-868d-044a2718ccd8 Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
bmorelli25
approved these changes
May 13, 2026
Member
bmorelli25
left a comment
There was a problem hiding this comment.
LG from my perspective. Ready for a review from someone else
Use a key-line match that works with the local Vale config and keep the workflow assertions compatible with released styles until the new rule ships. Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Vale Linting ResultsSummary: 11 warnings, 9 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| .github/test-fixtures/sample-violations.md | 2 | Elastic.MappedPages | mapped_pages should only be added or updated in rare scenarios. Talk with your local technical writer before pushing changes to this key. |
| .github/test-fixtures/sample-violations.md | 6 | Elastic.Articles | Use 'an FAQ' instead of 'a FAQ'. The article depends on pronunciation, not spelling. |
| .github/test-fixtures/sample-violations.md | 6 | Elastic.Articles | Use 'an HTML' instead of 'a HTML'. The article depends on pronunciation, not spelling. |
| .github/test-fixtures/sample-violations.md | 6 | Elastic.Articles | Use 'an SQL' instead of 'a SQL'. The article depends on pronunciation, not spelling. |
| .github/test-fixtures/sample-violations.md | 6 | Elastic.Articles | Use 'an HTML' instead of 'a HTML'. The article depends on pronunciation, not spelling. |
| .github/test-fixtures/sample-violations.md | 7 | Elastic.BritishSpellings | Use American English spelling 'optimize' instead of British English 'optimise'. |
| .github/test-fixtures/sample-violations.md | 7 | Elastic.BritishSpellings | Use American English spelling 'customize' instead of British English 'customise'. |
| .github/test-fixtures/sample-violations.md | 7 | Elastic.BritishSpellings | Use American English spelling 'behavior' instead of British English 'behaviour'. |
| .github/test-fixtures/sample-violations.md | 11 | Elastic.DontUse | Don't use 'just'. |
| .github/test-fixtures/sample-violations.md | 11 | Elastic.DontUse | Don't use 'please'. |
| .github/test-fixtures/sample-violations.md | 11 | Elastic.DontUse | Don't use 'aka'. |
💡 Suggestions (9)
| File | Line | Rule | Message |
|---|---|---|---|
| .github/test-fixtures/sample-violations.md | 8 | Elastic.WordChoice | Consider using 'efficiently' instead of 'Simply', unless the term is in the UI. |
| .github/test-fixtures/sample-violations.md | 8 | Elastic.WordChoice | Consider using 'allowlist' instead of 'whitelist', unless the term is in the UI. |
| .github/test-fixtures/sample-violations.md | 8 | Elastic.WordChoice | Consider using 'blocklist' instead of 'blacklist', unless the term is in the UI. |
| .github/test-fixtures/sample-violations.md | 9 | Elastic.OxfordComma | Use the Oxford comma in 'reading, writing and executing.'. |
| .github/test-fixtures/sample-violations.md | 10 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| .github/test-fixtures/sample-violations.md | 10 | Elastic.Wordiness | Consider using 'because' instead of 'due to the fact that'. |
| .github/test-fixtures/sample-violations.md | 10 | Elastic.Wordiness | Consider using 'many' instead of 'a large number of'. |
| .github/test-fixtures/sample-violations.md | 12 | Elastic.Exclamation | Use exclamation points sparingly. Consider removing the exclamation point. |
| .github/test-fixtures/sample-violations.md | 12 | Elastic.Exclamation | Use exclamation points sparingly. Consider removing the exclamation point. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
theletterf
approved these changes
May 13, 2026
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
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.
Most contributors should not add or modify
mapped_pagesin doc frontmatter; that metadata should be maintained by technical writers. This PR introduces a dedicated Vale warning to flag those edits while keeping guidance explicit in lint output.New lint rule:
Elastic.MappedPagesstyles/Elastic/MappedPages.yml.mapped_pagesappears inside YAML frontmatter (supports LF/CRLF).Rule coverage in existing lint fixture flow
.github/test-fixtures/sample-violations.mdto include frontmatter withmapped_pages..github/workflows/test-lint.ymlto assertElastic.MappedPagesfires in the fixture-based rule check list.Repo hygiene adjustment
.gitignoreto ignore Python bytecode/cache artifacts and removes previously tracked cache files fromlint/andreport/.