[April CQA] CQA and other fixes for MTA CLI

[mpershina]

Tracked under:

• https://redhat.atlassian.net/browse/MTA-6752
• https://redhat.atlassian.net/browse/MTA-6753
• https://redhat.atlassian.net/browse/MTA-6754

Preview: https://mpershina.github.io/Previews/MTA/CLI-preview.html

Summary by CodeRabbit

• Documentation
  • Reorganized CLI guide header and processing order; removed the inclusive-language include.
  • Increased table-of-contents depth and standardized content-type attributes across guides.
  • Minor formatting fixes across multiple docs (whitespace, trailing spaces, sample formatting, and ID/label adjustments).

[coderabbitai]

Warning

Rate limit exceeded

@mpershina has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 45 minutes and 10 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 45 minutes and 10 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9a4bbbbd-4cb8-4d06-a1a8-e9830f3897fa

📥 Commits

Reviewing files that changed from the base of the PR and between 5ec9594 and 7b9f488.

📒 Files selected for processing (1)

• docs/topics/mta-cli/ref_discovery_manifest_sample.adoc

📝 Walkthrough

Walkthrough

Reordered AsciiDoc front-matter in docs/cli-guide/master.adoc (moved document-attributes include and relocated ID/title), removed an inclusive-language include, and updated docs/topics/templates/document-attributes.adoc (added _mod-docs-content-type and increased :toclevels:). Multiple other docs received minor whitespace/attribute-name edits.

Changes

Cohort / File(s)	Summary
CLI Guide master docs/cli-guide/master.adoc	Moved include::topics/templates/document-attributes.adoc[] after initial attribute lines, relocated [id="cli-guide"] and title block, and removed include::topics/making-open-source-more-inclusive.adoc[].
Document attribute template docs/topics/templates/document-attributes.adoc	Added :_mod-docs-content-type: ATTRIBUTES and changed :toclevels: from 3 → 4.
MTA CLI attribute renames docs/topics/mta-cli/con_intro-to-the-cli.adoc, .../ref_effort-level-estimation.adoc, .../ref_mta-tech-tags.adoc	Renamed :_content-type: → :_mod-docs-content-type: in several reference/concept files.
Minor whitespace/text tidy assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc, assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc, docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc, docs/topics/mta-cli/ref_analysis-report-sections.adoc, docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc, docs/topics/mta-cli/ref_modify-application-profile.adoc, docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc	Whitespace and trailing-space removals, small formatting adjustments, and one sample manifest ID/format change (ref_discovery_manifest_sample.adoc) including ID rename and reformatting of example block.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• MTA-6288 Centralized configuration in MTA CLI #305: Modifies similar AsciiDoc files including docs/cli-guide/master.adoc and the document-attributes template.
• CQA 2.1 (FEB) - Install Guide #318: Changes docs/topics/templates/document-attributes.adoc (attribute declarations and top-of-file includes).
• [April CQA] Install doc master.adoc and spacing fixes #351: Reorders front-matter in other master.adoc files and adjusts _mod-docs-content-type usage similarly.

Suggested reviewers

• anarnold97
• eemcmullan
• ibragins
• Pkylas007

Poem

🐰 I hopped through headers, nudged attributes in line,
Moved the include, made the TOC deeper fine.
A trailing space I gently swept away,
New content types now cheer the day—hip hop hooray!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title '[April CQA] CQA and other fixes for MTA CLI' is vague and generic—it uses non-descriptive terms like 'CQA and other fixes' that don't convey what the actual changes are, making it unclear what the main change entails.	Consider a more descriptive title such as 'Restructure CLI guide preamble and update document attributes' or 'Update MTA CLI documentation metadata and content-type declarations' to clearly specify the primary changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch CLI-April

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[mpershina]

Based on the discussion in the MMS meeting

[anarnold97]

PR Review Report: CQA and fixes for MTA CLI

Summary

The PR is now largely aligned with team decisions regarding documentation standards. While initially flagged for inconsistency, it has been confirmed that the removal of the inclusive language statement and the ASSEMBLY attribute are desired architectural changes for this guide.

---

Updated Analysis

Inclusive Language Removal (Confirmed)

• Status: ✅ Approved
• Update: Following the discussion between the author and collaborator, it has been agreed to remove making-open-source-more-inclusive.adoc to align MTA documentation with previous RHEL documentation decisions.

Attribute:: mod-docs-content-type: ASSEMBLY

• Status: ✅ Resolved
• Update: It has been clarified that this attribute is not required for the master.adoc in this specific context. Its removal is intentional and does not require restoration for the sake of parity with other guides.

Attribute Ordering & toclevels Conflict

• Status: ⚠️ Technical Risk
• Details: AsciiDoc follows a "last-definition-wins" rule. By moving include::document-attributes.adoc (which sets toclevels: 3) to a position after the guide’s local :toclevels: 4, the template will override the guide.
• Impact: The Table of Contents depth will shrink from 4 levels to 3 in the published CLI guide.

Shared Template Update

• Status: ℹ️ Informational
• Details: Adding :_mod-docs-content-type: ATTRIBUTES to document-attributes.adoc correctly labels the shared file. This is a global change affecting all guides using this include, which is appropriate for metadata accuracy.

---

Revised Verdict

Ready to Merge (with minor technical adjustment)

Criterion	Status	Notes
Inclusive language removal	✅	Confirmed
ASSEMBLY attribute removal	✅	Confirmed
Attribute ordering	⚠️	Needs verification of toclevels

---

Recommended Final Actions

1. Fix TOC Regression: To maintain a TOC depth of 4, ensure the :toclevels: 4 declaration in master.adoc is placed below the include::document-attributes.adoc[] line.
2. Global Consistency (Future Task): Since the decision is now "Remove from MTA," consider creating a follow-up task to remove the inclusive language statement from the remaining guides (IntelliJ, Rules Development, Web Console) to ensure a unified user experience.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/topics/mta-cli/ref_discovery_manifest_sample.adoc (1)

17-51: Consider impact of removing YAML syntax highlighting.

The manifest example was converted from a [source, yaml] block to a plain delimited block. This removes syntax highlighting, which can reduce readability for structured data formats like YAML. If this change is part of a documentation-wide standardization effort, that's fine—but if syntax highlighting was removed unintentionally, consider restoring it:

💡 Alternative with syntax highlighting

-[subs="+quotes"]
+[source,yaml]
 ----
 manifest:

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/topics/mta-cli/ref_discovery_manifest_sample.adoc` around lines 17 - 51,
The manifest example lost YAML syntax highlighting when converted from a
[source,yaml] block to a plain delimited block (the block starting with
"[subs="+quotes"]" and the "manifest:" example); restore readability by changing
the block back to a source block with YAML highlighting (use the [source,yaml]
directive for the delimited manifest example) so the manifest, labels,
annotations, env, routes, processes, and buildPacks sections render with proper
syntax coloring.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/mta-cli/ref_discovery_manifest_sample.adoc`:
- Line 17: Remove the extraneous attribute [subs="+quotes"] from the manifest
sample block in ref_discovery_manifest_sample.adoc; locate the block header
containing [subs="+quotes"] and delete that attribute so the YAML manifest
sample (the static content) is rendered without unnecessary quote substitution
configuration.

---

Nitpick comments:
In `@docs/topics/mta-cli/ref_discovery_manifest_sample.adoc`:
- Around line 17-51: The manifest example lost YAML syntax highlighting when
converted from a [source,yaml] block to a plain delimited block (the block
starting with "[subs="+quotes"]" and the "manifest:" example); restore
readability by changing the block back to a source block with YAML highlighting
(use the [source,yaml] directive for the delimited manifest example) so the
manifest, labels, annotations, env, routes, processes, and buildPacks sections
render with proper syntax coloring.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 706e0c8a-fa63-4f84-8c3a-761bff807536

📥 Commits

Reviewing files that changed from the base of the PR and between 499e675 and 5ec9594.

📒 Files selected for processing (13)

• assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc
• assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc
• docs/cli-guide/master.adoc
• docs/topics/mta-cli/con_intro-to-the-cli.adoc
• docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc
• docs/topics/mta-cli/ref_analysis-report-sections.adoc
• docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc
• docs/topics/mta-cli/ref_discovery_manifest_sample.adoc
• docs/topics/mta-cli/ref_effort-level-estimation.adoc
• docs/topics/mta-cli/ref_modify-application-profile.adoc
• docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc
• docs/topics/mta-cli/ref_mta-tech-tags.adoc
• docs/topics/templates/document-attributes.adoc

💤 Files with no reviewable changes (1)

• assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc

✅ Files skipped from review due to trivial changes (9)

• docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc
• docs/topics/mta-cli/ref_modify-application-profile.adoc
• docs/topics/mta-cli/ref_analysis-report-sections.adoc
• docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc
• docs/topics/mta-cli/ref_effort-level-estimation.adoc
• docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc
• assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc
• docs/topics/mta-cli/con_intro-to-the-cli.adoc
• docs/topics/mta-cli/ref_mta-tech-tags.adoc

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/topics/templates/document-attributes.adoc
• docs/cli-guide/master.adoc