Add admonition format check and relax knowledge_article_id rule#761
Merged
Add admonition format check and relax knowledge_article_id rule#761
Conversation
- Flag Docusaurus admonition blocks (:::note, :::tip, :::warning, :::danger) in KB articles — writers should use blockquote callouts (> **NOTE:** / > **IMPORTANT:**) instead - knowledge_article_id: only flag if the field is present but empty; absent field is acceptable for articles not migrated from Salesforce
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.
Summary
/derekKB article quality reviewer skill based on issues identified during testing on PR docs: add PPE supportability statement as KB article #752./derekdid not flag:::noteand:::tipblocks that needed converting to KB-style blockquote callouts.knowledge_article_idrule was too strict — it flagged articles written natively in the repo without a ZD/SF ID.Changes
/dereknow flags Docusaurus admonition blocks (:::note,:::tip,:::warning,:::danger) in KB articles and tells the writer to convert them to blockquote callouts (> **NOTE:**or> **IMPORTANT:**). Vale handles inline "Note that" text —/derekhandles admonition syntax. No overlap.knowledge_article_idrule relaxed — field absent is no longer flagged. Only flagged if the field is present but empty. Articles written natively in the repo (not migrated from ZD/SF) will not have a ZD/SF ID, so requiring the field on all articles produced false positives.Testing
docs/kb/privilegesecure/remote-desktop-and-rds/configuring-the-netwrix-privilege-secure-rds-web-app-launcher.md, the only KB article with Docusaurus admonition syntax./derekcorrectly flagged:::warningat line 58 with theadmonition-formatrule and included the converted blockquote text in the message. Vale did not flag the same block — correct separation of concerns confirmed.knowledge_article_idabsent — tested ondocs/kb/passwordpolicyenforcer/ppe-supportability.md, which has noknowledge_article_idfield./derekfound 3 other issues but did not flag the missing field. Rule change confirmed working.knowledge_article_idpresent but empty — not tested against a real article (no suitable candidate available). Low-risk untested path.