MTA-6811, 6812, 6813 CQA April Developer Lightspeed work#357
Open
Pkylas007 wants to merge 10 commits into
Open
MTA-6811, 6812, 6813 CQA April Developer Lightspeed work#357Pkylas007 wants to merge 10 commits into
Pkylas007 wants to merge 10 commits into
Conversation
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR reorganizes and updates Developer Lightspeed documentation by removing the Solution Server assembly and tackle enablement procedure, standardizing terminology ("Visual Studio Code" vs "VS Code"), updating product placeholder references, rephrasing descriptions for clarity, and restructuring assembly include paths to reference moved documentation topics. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc`:
- Around line 23-25: Update the hardcoded navigation string in
docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc by replacing the
literal "Extensions > MTA Extension for VSCode > Settings" with the
variable-based path "Extensions > {ProductShortName} Extension for VSCode >
Settings" (or match the same pattern used in
docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc);
locate the occurrence of the exact string "Extensions > MTA Extension for VSCode
> Settings" in that file and perform the substitution so all VS Code extension
docs consistently use {ProductShortName}.
In `@docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc`:
- Line 33: Update the documented Command Palette entry so it matches other docs:
replace the current `{ProductShortName}: Open the Gen AI model provider
configuration file` text with `Open the GenAI model provider configuration file`
(remove the `{ProductShortName}:` prefix and merge "Gen AI" into "GenAI") to
ensure consistency with the `ref_llm-provider-configurations` and
`proc_configuring-llm-podman-desktop` documentation.
🪄 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: d8a945bd-c069-4139-861f-45d581985d08
📒 Files selected for processing (17)
assemblies/developer-lightspeed-guide/assembly_getting-started.adocdocs/topics/developer-lightspeed/assembly_solution-server-configurations.adocdocs/topics/developer-lightspeed/con_developer-lightspeed-logs.adocdocs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adocdocs/topics/developer-lightspeed/con_installation.adocdocs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adocdocs/topics/developer-lightspeed/con_llm-service-openshift-ai.adocdocs/topics/developer-lightspeed/con_prerequisites.adocdocs/topics/developer-lightspeed/con_solution_server.adocdocs/topics/developer-lightspeed/proc_apply-rag-resolution.adocdocs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adocdocs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adocdocs/topics/developer-lightspeed/proc_running-agent-analysis.adocdocs/topics/developer-lightspeed/proc_running-rag-analysis.adocdocs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adocdocs/topics/developer-lightspeed/ref_example-code-suggestion.adocdocs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc
💤 Files with no reviewable changes (2)
- assemblies/developer-lightspeed-guide/assembly_getting-started.adoc
- docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc
added 4 commits
April 21, 2026 13:28
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
vashirova
requested changes
Apr 24, 2026
Collaborator
vashirova
left a comment
vashirova
left a comment
There was a problem hiding this comment.
@Pkylas007 peer review completed, see my comments.
To summarize, the following issues are blockers for DITA migration and must be fixed:
- Abstracts
- Floating text
- Links in concept and assembly modules (in the main text)
- Alt text for images
Plus, a number of editorial and formatting issues.
…lies folder Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc (2)
62-62: Improve sentence clarity and parallel structure.The phrasing "streams the issue description, a preview of the code changes" lacks clear parallel structure. Consider rephrasing for clarity.
📝 Suggested rewording
-{mta-dl-plugin} streams the issue description, a preview of the code changes in files that resolve the issue. +{mta-dl-plugin} streams the issue description and a preview of the code changes in files that resolve the issue.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc` at line 62, The sentence using "{mta-dl-plugin}" lacks parallel structure; change the line to use a parallel verb structure such as "streams the issue description and previews the code changes that resolve the issue" or "streams the issue description and a preview of the code changes that resolve the issue" by editing the string containing "{mta-dl-plugin}" so the two coordinated elements are parallel (both verbs or both noun phrases) and preserve the original meaning.
70-70: Minor grammar improvement.The phrase "repeated iterations of scan" should use plural "scans" or be reworded for better grammatical flow.
📝 Suggested alternatives
Option 1:
-Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until it resolves all issues. +Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated scan iterations if you allow until it resolves all issues.Option 2:
-Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until it resolves all issues. +Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated scans if you allow until it resolves all issues.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc` at line 70, Replace the phrase "repeated iterations of scan" with a grammatically correct alternative such as "repeated scans" or "repeated iterations of scans" in the sentence that reads "Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until it resolves all issues." to improve flow and plurality; ensure the updated sentence reads smoothly (e.g., "...{mta-dl-plugin} continues to run repeated scans until it resolves all issues.").docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc (1)
23-23: Use {ProductShortName} instead of {ProductFirstRef} for UI navigation.Line 23 uses
{ProductFirstRef}which expands to "Migration toolkit for applications", creating the awkward navigation path: "Extensions > Migration toolkit for applications Extension > Settings".For UI navigation paths, use
{ProductShortName}(which expands to "MTA") to match what users see in the Visual Studio Code interface and maintain consistency with line 25.📝 Proposed fix
-.. Click `Extensions > {ProductFirstRef} Extension > Settings` +.. Click `Extensions > {ProductShortName} Extension > Settings`🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc` at line 23, The navigation text uses the wrong placeholder {ProductFirstRef} which expands to "Migration toolkit for applications" and produces an awkward path; replace {ProductFirstRef} with {ProductShortName} so the line reads "Extensions > {ProductShortName} Extension > Settings" to match the UI and line 25; update the string where it appears (search for the literal {ProductFirstRef} in the document) and ensure references elsewhere in this topic remain consistent with {ProductShortName}.
🤖 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/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc`:
- Around line 9-11: The intro states users "must enter your large language model
(LLM) credentials to use {mta-dl-plugin}" but the doc doesn't show where to
enter them; update the page by either (A) adding a short procedure step after
installation that explicitly shows how to configure LLM credentials for the
{mta-dl-plugin} (e.g., open VS Code Settings or settings.json and set the
{mta-dl-plugin} LLM credential key such as a plugin-specific API key/secret),
referencing the {mta-dl-plugin} setting name, or (B) if credentials are
documented elsewhere, change the abstract sentence to point readers to that
exact section or page where the credential field is documented; do not leave the
location unspecified.
In `@docs/topics/developer-lightspeed/proc_tackle-llm-secret.adoc`:
- Around line 29-31: The oc create secret generic command uses the wrong secret
name and omits the namespace; change the command that currently uses "oc create
secret generic aws-credentials" to create the expected secret name
"kai-api-keys" and add the namespace flag "-n openshift-mta" so the line becomes
the Amazon Bedrock secret creation matching other providers (refer to the oc
create secret generic invocation and the secret name kai-api-keys).
In `@docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc`:
- Line 68: The sentence "can occur when you accepted the suggested code change"
mixes present modal with past tense; update the phrase to use consistent present
tense, e.g., change it to "can occur when you accept the suggested code change"
so the modal "can" and the verb "accept" agree in tense and voice.
---
Nitpick comments:
In
`@docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc`:
- Line 23: The navigation text uses the wrong placeholder {ProductFirstRef}
which expands to "Migration toolkit for applications" and produces an awkward
path; replace {ProductFirstRef} with {ProductShortName} so the line reads
"Extensions > {ProductShortName} Extension > Settings" to match the UI and line
25; update the string where it appears (search for the literal {ProductFirstRef}
in the document) and ensure references elsewhere in this topic remain consistent
with {ProductShortName}.
In `@docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc`:
- Line 62: The sentence using "{mta-dl-plugin}" lacks parallel structure; change
the line to use a parallel verb structure such as "streams the issue description
and previews the code changes that resolve the issue" or "streams the issue
description and a preview of the code changes that resolve the issue" by editing
the string containing "{mta-dl-plugin}" so the two coordinated elements are
parallel (both verbs or both noun phrases) and preserve the original meaning.
- Line 70: Replace the phrase "repeated iterations of scan" with a grammatically
correct alternative such as "repeated scans" or "repeated iterations of scans"
in the sentence that reads "Repeat the review and accept or reject the
resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you
allow until it resolves all issues." to improve flow and plurality; ensure the
updated sentence reads smoothly (e.g., "...{mta-dl-plugin} continues to run
repeated scans until it resolves all issues.").
🪄 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: 250ea164-e85a-4990-a887-1b339f0e411b
📒 Files selected for processing (19)
assemblies/developer-lightspeed-guide/assembly_configuring-dev-lightspeed-ide.adocassemblies/developer-lightspeed-guide/assembly_configuring_llm.adocassemblies/developer-lightspeed-guide/assembly_getting-started.adocassemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adocassemblies/developer-lightspeed-guide/assembly_understanding_dl.adocdocs/developer-lightspeed-guide/master.adocdocs/topics/developer-lightspeed/assembly_getting-started.adocdocs/topics/developer-lightspeed/con_installation.adocdocs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adocdocs/topics/developer-lightspeed/con_llm-service-openshift-ai.adocdocs/topics/developer-lightspeed/con_persistent-volumes.adocdocs/topics/developer-lightspeed/con_prerequisites.adocdocs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adocdocs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adocdocs/topics/developer-lightspeed/proc_running-agent-analysis.adocdocs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adocdocs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adocdocs/topics/developer-lightspeed/proc_tackle-llm-secret.adocdocs/topics/developer-lightspeed/ref_example-code-suggestion.adoc
💤 Files with no reviewable changes (2)
- docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc
- docs/topics/developer-lightspeed/assembly_getting-started.adoc
✅ Files skipped from review due to trivial changes (8)
- docs/developer-lightspeed-guide/master.adoc
- docs/topics/developer-lightspeed/con_persistent-volumes.adoc
- docs/topics/developer-lightspeed/con_installation.adoc
- docs/topics/developer-lightspeed/con_prerequisites.adoc
- assemblies/developer-lightspeed-guide/assembly_configuring_llm.adoc
- docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc
- assemblies/developer-lightspeed-guide/assembly_understanding_dl.adoc
- docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc
🚧 Files skipped from review as they are similar to previous changes (4)
- assemblies/developer-lightspeed-guide/assembly_getting-started.adoc
- docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc
- docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc
- docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc
| . Click *Continue* to allow {mta-dl-plugin} to run a follow-up analysis. | ||
| + | ||
| This round of analysis detects lint issues, compilation issues, or diagnostic issues that may have occurred when you accepted the suggested code change. | ||
| This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accepted the suggested code change. |
Contributor
There was a problem hiding this comment.
Fix verb tense consistency.
The phrase "can occur when you accepted" mixes present modal ("can occur") with past tense ("accepted"). Use consistent tense.
✏️ Proposed fix for tense consistency
-This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accepted the suggested code change.
+This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accept the suggested code change.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accepted the suggested code change. | |
| This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accept the suggested code change. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc` at line
68, The sentence "can occur when you accepted the suggested code change" mixes
present modal with past tense; update the phrase to use consistent present
tense, e.g., change it to "can occur when you accept the suggested code change"
so the modal "can" and the verb "accept" agree in tense and voice.
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Collaborator
Author
I'm evaluating how practical is it to remove links from the main text. The links are more useful in the main text in some cases where they are referenced. |
added 3 commits
May 4, 2026 14:01
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
This reverts commit 1f2ecda.
Collaborator
Author
|
@vashirova I have addressed all the concerns here and ran DITA validation that was passed by Claude Code. Can you please review the PR? |
Collaborator
@Pkylas007 thank you! As we are having a release next week, my capacity is limited but I'll try my best to complete review this week. |
Collaborator
Author
Hi @vashirova , Thank you but please do not rush with this! I didn't know about the release. Please take your time 😄 |
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.
JIRA
CQA validation
Version
Preview
Summary by CodeRabbit
Release Notes