Add profile sync prerequisites in the Visual Studio Code guide#373
Conversation
|
Warning Review limit reached
Next review available in: 48 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughUpdated profile-analysis documentation across the UI, CLI, and Visual Studio Code procedures. The changes clarify profile downloads, expand Hub-profile prerequisites, add an archetype-tag requirement for CLI analysis, and reformat Hub configuration instructions. ChangesProfile analysis documentation updates
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/topics/vscode/proc_configuring-profile-settings.adoc`:
- Line 17: The prerequisites section contains an empty bullet that renders as a
blank list item, so update the list entry in the configuring-profile-settings
topic by either restoring the missing prerequisite text or removing the bullet
entirely. Locate the empty item in the prerequisites list and ensure the section
reads cleanly without placeholder markup or blank list entries.
🪄 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: 0b0429db-b3bd-4560-b57a-7f6b13397ea7
📒 Files selected for processing (3)
docs/topics/mta-ui/proc_configuring-target-profiles.adocdocs/topics/vscode/proc_configuring-profile-settings.adocdocs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
|
@rromannissen Please review the prerequisites necessary for the profile sync. Thanks! |
Pkylas007
changed the title
rromannissen
left a comment
rromannissen
left a comment
There was a problem hiding this comment.
It's ok, with a few minor changes required.
| * You opened a project written in one of the supported languages in your Visual Studio Code workspace. {ProductShortName} can analyze source code written in `Java`, `C#`, `.NET`, `Go`, and `JavaScript`. | ||
| * An architect has configured an analysis profile in the Hub. | ||
| * An architect has configured an analysis profile in the {ProductShortName} web console. | ||
| * The repository URL of the application opened in the Visual Studio Code workspace must match the application repository URL when you configured the application in the {ProductShortName} web console. |
There was a problem hiding this comment.
The repository URL of the local application must match an existing application in the Hub would be more accurate. The current sentence somehow implies that the person working with the application locally in VSCode is the same that configured it in the Hub, which is likely not going to be the case.
| * An architect has configured an analysis profile in the Hub. | ||
| * An architect has configured an analysis profile in the {ProductShortName} web console. | ||
| * The repository URL of the application opened in the Visual Studio Code workspace must match the application repository URL when you configured the application in the {ProductShortName} web console. | ||
| * The application has a tag that matches with an archetype tag in the web console. |
There was a problem hiding this comment.
I would live this like "the application is associated to an Archetype" or "the application matches an Archetype". There is no such thing as an "archetype tag", there are "criteria tags" in Archetypes that drive their association with applications.
| * The repository URL of the application opened in the Visual Studio Code workspace must match the application repository URL when you configured the application in the {ProductShortName} web console. | ||
| * The application has a tag that matches with an archetype tag in the web console. | ||
| * The archetype has at least one target profile. | ||
| * You selected the analysis profile in the target profile. |
There was a problem hiding this comment.
This is confusing. It is not "you" (with you meaning the person working in VSCode) whom associated the analysis profile in the Hub, it was the Architect. I think the perspective is essential here, as the overarching narrative for this feature is "Developers working with the VSCode extension seamlessly consume the configuration that Architects manage and put together in the Hub".
|
@rromannissen Thank you for the feedback! Could you check the updates, please? |
| * Your Administrator installed {ProductShortName} and the `tackle` operator in your cluster. | ||
| * The Architect configured an analysis profile with required custom rules in the {ProductShortName} {WebName}. | ||
| * The Architect added the analysis profile in the application's target profile in the {ProductShortName} {WebName}. | ||
| * In the {ProductShortName} {WebName}, the application has a tag that matches with an archetype tag. |
There was a problem hiding this comment.
| * In the {ProductShortName} {WebName}, the application has a tag that matches with an archetype tag. | |
| * In the {ProductShortName} {WebName}, the application has a tag that matches an archetype tag. |
| . Click the *Tag category* field and select the category tag to associate with the tag. | ||
| . Select specific generators and click the right arrow to move the generator from the *Available generators* list to the *Chosen generators* list. | ||
| . (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list. | ||
| . (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} and the Visual Studio Code extension only if you select the profile from this list. |
There was a problem hiding this comment.
| . (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} and the Visual Studio Code extension only if you select the profile from this list. | |
| . Optional: Select an analysis profile for the application from the list. You can download the profile configuration from the {ProductShortName} {CLIName} and the Visual Studio Code extension only if you select the profile from this list. |
| * You opened a project written in one of the supported languages in your Visual Studio Code workspace. {ProductShortName} can analyze source code written in `Java`, `C#`, `.NET`, `Go`, and `JavaScript`. | ||
| * An architect has configured an analysis profile in the Hub. | ||
| * An architect has configured an analysis profile in the {ProductShortName} web console. | ||
| * The repository URL of the local application must match an existing application in the {ProductShortName} web console. |
There was a problem hiding this comment.
To preserve the parallel structure required for lists
| * The repository URL of the local application must match an existing application in the {ProductShortName} web console. | |
| * The repository URL of the local application matches an existing application in the {ProductShortName} web console. |
| * An architect has configured an analysis profile in the Hub. | ||
| * An architect has configured an analysis profile in the {ProductShortName} web console. | ||
| * The repository URL of the local application must match an existing application in the {ProductShortName} web console. | ||
| * The application has a tag that matches with a criteria tag in an archetype. |
There was a problem hiding this comment.
| * The application has a tag that matches with a criteria tag in an archetype. | |
| * The application has a tag that matches a criteria tag in an archetype. |
| .. Log in to the Hub by enabling the *Enable authentication* switch. | ||
| .. Enter the username and password credentials of the {ProductShortName} user interface. | ||
| .. To use the Solution Server to suggest resolutions for the issues in the source code, enable *Solution Server* . | ||
| .. To use the Solution Server to suggest resolutions for the issues in the source code, enable *Solution Server*. |
There was a problem hiding this comment.
| .. To use the Solution Server to suggest resolutions for the issues in the source code, enable *Solution Server*. | |
| .. To generate code resolutions for issues in your source code, enable *Solution Server*. |
| {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. | ||
| + | ||
| When you enable the profile sync and the administrator has deployed LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM. |
There was a problem hiding this comment.
Please, just check the tech accuracy for the second paragraph.
| {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. | |
| + | |
| When you enable the profile sync and the administrator has deployed LLM proxy in the cluster, {ProductShortName} uses the proxy service to connect to the LLM. | |
| To update your profiles and rules, you must synchronize them with the Hub. | |
| + | |
| When you enable synchronization, {ProductShortName} connects to the large language model (LLM). If an administrator deployed the LLM proxy, the extension routes connections through this service. |
There was a problem hiding this comment.
At the moment, I have not changed the second paragraph much since that would require an SME review to make sure any change is accurate. However, I have moved it as a point under the previous step that speaks about enabling the Solution Server 👍
mpershina
left a comment
mpershina
left a comment
There was a problem hiding this comment.
Left some suggestions
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc`:
- Line 49: Correct the profile synchronization instruction in the documentation
sentence: state that updating profiles and rules requires synchronizing them
with the Hub, and fix the duplicated “profiles” wording. Preserve the
surrounding instructions and terminology.
- Around line 44-46: Update the Solution Server documentation near the “Solution
Server” enablement instruction to state explicitly that the administrator must
deploy the LLM proxy in the cluster for code resolutions to work. Replace the
conditional wording in the following proxy-service sentence with a clear
prerequisite, while preserving the existing explanation that {ProductShortName}
connects to the LLM through the proxy.
🪄 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: b1c5885d-5a1c-419a-a576-067d54bfde61
📒 Files selected for processing (3)
docs/topics/mta-cli/proc_analyzing-app-with-profile.adocdocs/topics/mta-ui/proc_configuring-target-profiles.adocdocs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/topics/mta-cli/proc_analyzing-app-with-profile.adoc
- docs/topics/mta-ui/proc_configuring-target-profiles.adoc
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
bbe49d5 to
7e9059c
Compare
3 participants
JIRA
Version
Previews
Summary by CodeRabbit
Summary by CodeRabbit