[April CQA] MTA CLI formatting, markup, and the remaining CQA fixes#358
Merged
[April CQA] MTA CLI formatting, markup, and the remaining CQA fixes#358
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR updates MTA documentation across 13 files with consistency improvements for Developer Preview terminology, enhanced AsciiDoc formatting for code examples, updated cross-references, and refined text styling and wording throughout CLI-related procedures and references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 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/proc_analyzing-app-with-profile.adoc`:
- Line 48: The placeholder in the AsciiDoc command example uses hyphens but
should use underscores per the repo style; update the command string in the
mta-cli example (the line containing "mta-cli config sync --url
https://github.com/_<my-app-repository>_ --application-path _<path_to_my_app>_
--insecure") to replace `<my-app-repository>` with `<my_app_repository>` (keep
the surrounding underscores/italics like the other placeholders) so it matches
the repository's underscore convention for placeholders.
In `@docs/topics/mta-cli/proc_generate_deployment_assets_values_file.adoc`:
- Around line 71-72: Remove the standalone continuation marker '+' that appears
immediately after the `where` definition list; replace that '+' line with a
plain blank line so the sentence "The variable priority hierarchy for generating
deployment manifests is as follows:" is not treated as a continuation of the
last `where` item and renders as a separate paragraph.
In `@docs/topics/mta-cli/proc_generating-deployment-manifest.adoc`:
- Around line 48-51: Remove the duplicated `cat Dockerfile` snippet from the
"Verify the ConfigMap" section and keep the Dockerfile verification command only
in the "Verify the Dockerfile" section; search for the headings "Verify the
ConfigMap" and "Verify the Dockerfile" and delete the `[subs="+quotes"] ---- $
*cat Dockerfile* ----` block found under the ConfigMap heading (the block at the
adjacent 53-63 area) so the Dockerfile is verified exclusively in the Dockerfile
step.
In `@docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc`:
- Line 13: Update the phrasing that currently reads "is a default mode" to use
the definite article — change it to "is the default mode" in the sentence
describing Containerless CLI; locate the sentence containing the exact fragment
"Containerless CLI is a default mode" and replace that fragment so the line
reads "Containerless CLI is the default mode."
In `@docs/topics/mta-cli/ref_modify-application-profile.adoc`:
- Line 72: The description for the `labels` field has a subject-verb agreement
error: change the verb "filters" to the plural form "filter" so the sentence
reads "Specifies the labels that filter rules that are applied and excluded in
the analysis." Update the string containing `labels`:: in the docs (the line
with `labels`:: Specifies...) to use "filter" instead of "filters".
🪄 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: 31dc50f8-33c9-4b4e-9570-24d1af5bd8ed
📒 Files selected for processing (14)
assemblies/cli-guide/assembly_generating-assets.adocassemblies/cli-guide/assembly_reference-material.adocdocs/topics/mta-cli/proc_analyze-unsupported-provider.adocdocs/topics/mta-cli/proc_analyzing-app-with-profile.adocdocs/topics/mta-cli/proc_analyzing-multiple-apps-with-mta-cli.adocdocs/topics/mta-cli/proc_assets-generation-example.adocdocs/topics/mta-cli/proc_concealing-sensitive-information.adocdocs/topics/mta-cli/proc_generate_deployment_assets_values_file.adocdocs/topics/mta-cli/proc_generating-deployment-manifest.adocdocs/topics/mta-cli/proc_performing-a-live-discovery.adocdocs/topics/mta-cli/proc_reviewing-analysis-issues-and-incidents.adocdocs/topics/mta-cli/proc_running-the-containerless-mta-cli.adocdocs/topics/mta-cli/ref_modify-application-profile.adocdocs/topics/mta-cli/ref_supported-migration-paths.adoc
mpershina
commented
Apr 16, 2026
mpershina
commented
Apr 16, 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
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.
Tracked under:
Preview: https://mpershina.github.io/Previews/MTA/CLI-fixes.html
Summary by CodeRabbit
Documentation