[MTA] Quick style fixes for Installing the migration toolkit for applications#335
Merged
[MTA] Quick style fixes for Installing the migration toolkit for applications#335
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR makes small, editorial AsciiDoc changes across the mta-install docs: normalizes "Red Hat build of Keycloak" capitalization, adjusts role/ persona capitalization, clarifies a Docker CLI prerequisite (Windows containers + OS/Arch), tightens Vale Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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: 2
🧹 Nitpick comments (1)
docs/topics/mta-install/proc_installing-mta-operator.adoc (1)
67-67: Prefer internalxrefover a versioned externallinkfor local docs targets.This points to a versioned published URL, which can become stale and is inconsistent with Line 68. Use an internal
xrefto keep links stable across doc versions/build contexts.🔧 Suggested change
-* link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] +* xref:persistent-volume-requirements_installing-mta-ui[Persistent volume requirements]🤖 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` at line 67, Replace the external, versioned link that uses link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[...] with an internal xref to the installing_the_migration_toolkit_for_applications topic using the anchor persistent-volume-requirements_installing-mta-ui and keep the visible link text "Persistent volume requirements" so the link is stable across doc versions.
🤖 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-install/proc_accessing-rhbk-admin-console.adoc`:
- Line 34: The link label in the AsciiDoc line containing
"link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/red_hat_build_of_keycloak_features_and_concepts[Red
Hat build of Keycloak features and concepts ]" has a trailing space before the
closing bracket; remove that extra space so the label reads "...features and
concepts]" (i.e., update the label text "Red Hat build of Keycloak features and
concepts " to "Red Hat build of Keycloak features and concepts") to ensure
consistent rendering.
In `@docs/topics/mta-install/proc_installing-mta-operator.adoc`:
- Line 16: The bullet at "* Any cloud services or self-hosted editions of Red
Hat OpenShift on versions 4.13-4.15." is a fragment and should be reworded as a
clear prerequisite; replace that line (the OpenShift requirement) with a direct
statement such as "Prerequisite: Red Hat OpenShift (cloud or self-hosted)
version 4.13–4.15." to remove ambiguity and make the requirement explicit.
---
Nitpick comments:
In `@docs/topics/mta-install/proc_installing-mta-operator.adoc`:
- Line 67: Replace the external, versioned link that uses
link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[...]
with an internal xref to the installing_the_migration_toolkit_for_applications
topic using the anchor persistent-volume-requirements_installing-mta-ui and keep
the visible link text "Persistent volume requirements" so the link is stable
across doc versions.
🪄 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: 2595355b-e4b7-4d01-b4d6-510fe06bc191
📒 Files selected for processing (6)
assemblies/mta-install-title/assembly_red-hat-build-of-keycloak.adocdocs/topics/mta-install/con_roles-personas-users-permissions.adocdocs/topics/mta-install/proc_accessing-rhbk-admin-console.adocdocs/topics/mta-install/proc_installing-cli-for-docker.adocdocs/topics/mta-install/proc_installing-cli-zip.adocdocs/topics/mta-install/proc_installing-mta-operator.adoc
mpershina
commented
Mar 31, 2026
| @@ -28,13 +28,15 @@ pass:[<!-- vale RedHat.Spelling = YES -->] For more information, see link:{mta-U | |||
| . Navigate to the link:{DevDownloadPageURL}[{ProductShortName} download page] and download one of the following operating system-specific CLI files or the `src` file: | |||
| + | |||
| pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->] | |||
Collaborator
Author
There was a problem hiding this comment.
This one cause the rendering issue
mpershina
commented
Mar 31, 2026
|
|
||
| . Navigate to the link:{DevDownloadPageURL}[{ProductShortName} download page] and download one of the following operating system-specific CLI files or the `src` file: | ||
| + | ||
| pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->] |
Collaborator
Author
There was a problem hiding this comment.
This guy breaks the rendering. Do you have any idea on how to have it here and avoid issues with rendering?
Collaborator
There was a problem hiding this comment.
you are right -> remove
mpershina
commented
Mar 31, 2026
|
|
||
| [role="_abstract"] | ||
| Starting from version 7.3.0, the {ProductFullName} uses the link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[Red Hat Build of Keycloak (RHBK)] instance for user authentication and authorization. A RHBK instance is installed during the installation of the {ProductShortName} user interface. The {ProductShortName} Operator manages the RHBK instance and configures a dedicated realm with necessary roles and permissions. | ||
| Starting from version 7.3.0, the {ProductFullName} uses the link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[Red Hat build of Keycloak (RHBK)] instance for user authentication and authorization. A RHBK instance is installed during the installation of the {ProductShortName} user interface. The {ProductShortName} Operator manages the RHBK instance and configures a dedicated realm with necessary roles and permissions. |
Collaborator
Author
There was a problem hiding this comment.
anarnold97
reviewed
Mar 31, 2026
| * Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15. | ||
| * You are logged in as a user with `cluster-admin` permissions. | ||
| * You environment has 4 vCPUs, 8 GB RAM, and 40 GB persistent storage. | ||
| * Your environment uses Red Hat OpenShift (cloud service or self-hosted), version 4.13–4.15. |
Collaborator
There was a problem hiding this comment.
are we sure about these version of OCP?
Collaborator
Author
There was a problem hiding this comment.
Not really. SME reviewed it some time ago, but I think they might've skipped this.. I will create a separate ticket for it and will take care of the changes.
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 https://redhat.atlassian.net/browse/MTA-6720
Preview: https://mpershina.github.io/Previews/MTA/Install-fixes.html
Summary by CodeRabbit