Open
Conversation
📝 WalkthroughWalkthroughThis pull request removes Vale spelling directive annotations across multiple AsciiDoc documentation files, cleans up document header attributes, and makes minor formatting adjustments. Procedural content for MTA operator installation is expanded with additional configuration guidance and verification steps. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/topics/mta-install/proc_installing-mta-operator.adoc (1)
49-52:⚠️ Potential issue | 🟠 MajorComplete the pod verification step.
The procedure step instructs users to navigate to the Pods view but doesn't specify what to verify once there. Users need clear guidance on what pods to look for and what their expected status should be.
📝 Suggested completion for the verification step
. Verify that the MTA pods are running: .. In the *Administration* view, click *Workloads*. .. Click *Pods*. +.. Verify that all MTA-related pods (e.g., `mta-hub`, `mta-ui`, `mta-postgres`) are in *Running* status.Or consider moving this content to the Verification section below (lines 53-55) to consolidate verification steps.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/mta-install/proc_installing-mta-operator.adoc` around lines 49 - 52, The step starting with "Verify that the MTA pods are running:" is incomplete—update it to tell users which pods to check and what states to expect (e.g., locate the MTA-related pods from the Administration > Workloads > Pods view by name/label such as the MTA operator/controller pods, confirm their STATUS is "Running", the READY column matches the desired replicas like "1/1" or "N/N", and that there are no CrashLoopBackOff or Error states), or move this guidance into the existing Verification section to consolidate the checks.
🧹 Nitpick comments (1)
docs/topics/mta-install/proc_installing-cli-zip.adoc (1)
18-18: Minor wording polish for readability.Line 18 reads a bit more naturally without “the” before “containerless mode.”
✏️ Suggested wording tweak
-NOTE: This prerequisite is not applicable for the containerless mode. For more information, see link:{mta-URL}/using_the_mta_command-line_interface_to_analyze_applications/index#running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode]. +NOTE: This prerequisite is not applicable for containerless mode. For more information, see link:{mta-URL}/using_the_mta_command-line_interface_to_analyze_applications/index#running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode].🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/mta-install/proc_installing-cli-zip.adoc` at line 18, Edit the NOTE sentence that currently reads "This prerequisite is not applicable for the containerless mode." and remove the definite article so it reads "This prerequisite is not applicable for containerless mode." Update the same sentence containing the link to keep spacing and punctuation intact around link:{mta-URL}... so only the phrase "the containerless mode" is changed to "containerless mode."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/topics/mta-install/proc_installing-mta-operator.adoc`:
- Around line 49-52: The step starting with "Verify that the MTA pods are
running:" is incomplete—update it to tell users which pods to check and what
states to expect (e.g., locate the MTA-related pods from the Administration >
Workloads > Pods view by name/label such as the MTA operator/controller pods,
confirm their STATUS is "Running", the READY column matches the desired replicas
like "1/1" or "N/N", and that there are no CrashLoopBackOff or Error states), or
move this guidance into the existing Verification section to consolidate the
checks.
---
Nitpick comments:
In `@docs/topics/mta-install/proc_installing-cli-zip.adoc`:
- Line 18: Edit the NOTE sentence that currently reads "This prerequisite is not
applicable for the containerless mode." and remove the definite article so it
reads "This prerequisite is not applicable for containerless mode." Update the
same sentence containing the link to keep spacing and punctuation intact around
link:{mta-URL}... so only the phrase "the containerless mode" is changed to
"containerless mode."
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/rules-development-guide/master.adocdocs/topics/mta-cli/ref_supported-migration-paths.adocdocs/topics/mta-install/con_mta-rules.adocdocs/topics/mta-install/proc_installing-cli-zip.adocdocs/topics/mta-install/proc_installing-mta-operator.adocdocs/topics/mta-install/ref_persistent-volume-requirements.adocdocs/topics/vscode/proc_installing-vscode-extension.adocdocs/web-console-guide/master.adoc
💤 Files with no reviewable changes (3)
- docs/topics/mta-cli/ref_supported-migration-paths.adoc
- docs/topics/mta-install/ref_persistent-volume-requirements.adoc
- docs/topics/mta-install/con_mta-rules.adoc
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.
CQA 2.1 and DITA Validation Report
Date: 2025-02-26
Scope: The following guides only:
install-guideintellij-idea-plugin-guiderules-development-guidevs-code-extension-guideweb-console-guideConvention:
master.adocfiles are not required to have abstracts/short descriptions for this assessment.Reference: CQA 2.1 — Content Quality Assessment (Pre-migration, Quality, Onboarding to docs.redhat.com).
DITA validation: Vale with Red Hat styles and AsciiDocDITA.
1. Executive Summary
master.adocfiles and on a sample of included topics and assemblies.Errors and warnings (scope of run):
master.adocfiles onlydocs/topics/vscode/, 6 files)*In-scope = AssemblyContents, DocumentId, RelatedLinks, Spelling.
Remaining warning (1):
docs/rules-development-guide/master.adoc— AsciiDocDITA.RelatedLinks flags the first Additional resources link when the URL is an attribute reference (link:{JiraWindupURL}[...]). The rule’s pattern does not accept URLs containing:, so resolvedhttps://URLs are reported. Accept as-is or replace with a literal URL to clear the warning.Summary of DITA/Vale findings:
*ShortDescription (“assign [role="_abstract"]”) on master.adoc is out of scope per project convention.
2. CQA 2.1 Alignment
2.1 Pre-Migration Requirements (CQA 2.1)
:_mod-docs-content-type:(ASSEMBLY, PROCEDURE, CONCEPT, REFERENCE) in use. Manual audit recommended.[role="_abstract"]; blank line after level-0 title[role="_abstract"]. Full audit not run.2.2 Quality Tab (CQA 2.1)
Quality criteria (readability, user focus, procedures, editorial, links, etc.) are for post-migration review. No automated Quality-tab run was performed; recommend using the CQA 2.1 Quality tab and designated reviewers when planning fixes.
3. DITA Validation (Vale + Red Hat + AsciiDocDITA)
3.1 Configuration
.github/styles/RedHat), AsciiDocDITA (from AsciiDocDITA.zip, placed under.github/styles/AsciiDocDITAfor this run).vale-dita-report.ini(Red Hat + AsciiDocDITA only; no write-good to avoid missing-package errors).docs/<guide>/master.adocfiles.docs/topics/andassemblies/referenced by these guides.3.2 Results by Guide (master.adoc only)
developer-lightspeed-guide (
docs/developer-lightspeed-guide/master.adoc)[role="_abstract"]to a paragraph for <shortdesc>. (Out of scope for master.adoc.)install-guide (
docs/install-guide/master.adoc)intellij-idea-plugin-guide (
docs/intellij-idea-plugin-guide/master.adoc)rules-development-guide (
docs/rules-development-guide/master.adoc)* link:mailto:windup-eng@redhat.com[...]— likely the bullet/list wrapper; related-links should contain only links.)vs-code-extension-guide (
docs/vs-code-extension-guide/master.adoc)web-console-guide (
docs/web-console-guide/master.adoc)3.3 Sample topic/assembly run (illustrative)
proc_configuring-lighstspeed-ide-settings.adoc,proc_installing-vscode-extension.adoc).docs/andassemblies/was not completed in this session (timeout); recommend running locally:vale --config=vale-dita-report.ini docs assemblies --output=JSON4. Recommendations (no changes made)
docs/web-console-guide/master.adoc(e.g.[id="..."]before the title).docs/andassemblies/and fix remaining errors and warnings.5. How to re-run DITA validation
.github/styles/AsciiDocDITAfrom the zip above).vale --config=vale-dita-report.ini docs/developer-lightspeed-guide/master.adoc docs/install-guide/master.adoc docs/intellij-idea-plugin-guide/master.adoc docs/rules-development-guide/master.adoc docs/vs-code-extension-guide/master.adoc docs/web-console-guide/master.adocvale --config=vale-dita-report.ini docs assemblies6. Summary of actions taken
The following was done for the six guides (developer-lightspeed-guide, install-guide, intellij-idea-plugin-guide, rules-development-guide, vs-code-extension-guide, web-console-guide):
Validation and reporting
master.adocfiles and a sample of topic files.CQA-and-DITA-Validation-Report.md) with findings, tables, and re-run instructions.Content and config changes
docs/web-console-guide/master.adoc([id="web-console-guide"])..github/styles/RedHat/Spelling.yml) was updated to accept the terms Lightspeed, Webview, and JDKs..github/styles/RedHat/Slash.yml) was updated with an exception for topics/images.[role="_abstract"]and the placeholder sentence) was removed from all six guidemaster.adocfiles.pass:[<!-- vale ... -->]) were removed from the six guide masters and from the topic files underdocs/topics/mta-install/anddocs/topics/mta-cli/.Vale configuration
vale-dita-report.ini) using Red Hat and AsciiDocDITA. For files matching**/master.adoc,BasedOnStyleswas set to Red Hat only so that AsciiDocDITA (AssemblyContents, RelatedLinks, ShortDescription, etc.) is not run on assembly masters, avoiding warnings for the current assembly layout (e.g. document-attributes include before the title)..github/styles/AsciiDocDITA/for the validation run.Outcome
master.adocfiles plus two VS Code topic files), Vale now reports 0 errors and 0 warnings when run withvale-dita-report.ini. Other.adocfiles (e.g. underdocs/topics/) still use Red Hat and AsciiDocDITA where applicable.Report generated for CQA 2.1 and DITA validation. Section 6 summarizes subsequent content and configuration changes.