Enable DITA validation rules for Vale on rhacs-docs-main#108476
Open
kcarmichael08 wants to merge 1 commit intoopenshift:rhacs-docs-mainfrom
Open
Enable DITA validation rules for Vale on rhacs-docs-main#108476kcarmichael08 wants to merge 1 commit intoopenshift:rhacs-docs-mainfrom
kcarmichael08 wants to merge 1 commit intoopenshift:rhacs-docs-mainfrom
Conversation
Aligns the Vale configuration with the main branch to enable AsciiDoc DITA validation rules. This enables automated PR review comments for DITA compliance issues through the Prow vale-review job. Changes: - Fix Packages line syntax (add missing comma) - Add Vocab = OpenShiftDocs - Remove AsciiDocDITA from BasedOnStyles (rules applied via explicit configuration) - Enable 23 DITA rules at error level (AdmonitionTitle, AssemblyContents, AuthorLine, BlockTitle, CalloutList, ContentType, DiscreteHeading, DocumentID, DocumentTitle, EntityReference, EquationFormula, ExampleBlock, LineBreak, MismatchedID, NestedSection, PageBreak, RelatedLinks, ShortDescription, SidebarBlock, TableFooter, TaskContents, TaskProcedure, TaskTitle) - Enable RedHat.ReleaseNotes = NO These changes ensure that DITA validation errors are caught during PR reviews, improving documentation quality for DITA conversion readiness. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
openshift-ci
bot
added
the
size/M
kcarmichael08
added
the
RHACS
|
🤖 Tue Mar 17 15:51:41 - Prow CI generated the docs preview: |
|
@kcarmichael08: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
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
2 participants
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.
Version(s): main, no cherry picks
Issue: https://redhat.atlassian.net/browse/ROX-33629
Link to docs preview:
QE review: N/A
Additional information:
Aligns the Vale configuration with the main branch to enable AsciiDoc DITA validation rules. This enables automated PR review comments for DITA compliance issues through the Prow vale-review job.
Changes:
These changes ensure that DITA validation errors are caught during PR reviews, improving documentation quality for DITA conversion readiness.