Skip to content

Add profile sync prerequisites in Visual Studio Code guide#373

Open
Pkylas007 wants to merge 4 commits into
mainfrom
vscode-profile-sync
Open

Add profile sync prerequisites in Visual Studio Code guide#373
Pkylas007 wants to merge 4 commits into
mainfrom
vscode-profile-sync

Conversation

@Pkylas007

@Pkylas007 Pkylas007 commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

JIRA

Version

  • 8.1.0

Previews

Summary by CodeRabbit

  • Documentation
    • Clarified the steps for configuring and using target profiles when analyzing applications.
    • Expanded prerequisites to include matching repository, tag, archetype, and target profile conditions.
    • Updated guidance for downloading analysis profile settings from both the CLI and Visual Studio Code when a profile is selected.
    • Improved instructions around Hub profile analysis and related configuration options.

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated profile-analysis documentation across UI, CLI, and VS Code. The changes add a Visual Studio Code download note for analysis profiles, expand prerequisite conditions for Hub profile use, add an archetype-tag requirement for CLI analysis, and reformat Hub configuration instructions.

Changes

Profile analysis documentation updates

Layer / File(s) Summary
Target profile note
docs/topics/mta-ui/proc_configuring-target-profiles.adoc
The optional analysis-profile step now mentions the Visual Studio Code extension as another download source when a profile is selected from the list.
Profile prerequisites
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc, docs/topics/mta-cli/proc_analyzing-app-with-profile.adoc
The VS Code page retitles the procedure to reference Hub profiles and expands its prerequisite checklist; the CLI page adds an archetype-tag prerequisite.
Hub configuration wording
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
The Solution Server and Profile Sync instructions are reformatted while preserving the notes about disabled sync and LLM proxy usage.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • anarnold97
  • mpershina

Poem

A bunny hops through docs at dawn,
With profiles, tags, and notes newly drawn.
VS Code and CLI now agree,
The Hub keeps its sync-waltz quietly.
🐇📘

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main VS Code documentation change about adding profile sync prerequisites.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch vscode-profile-sync

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

Comment @coderabbitai help to get the list of available commands.

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a22f4a0 and ee37736.

📒 Files selected for processing (3)
  • docs/topics/mta-ui/proc_configuring-target-profiles.adoc
  • docs/topics/vscode/proc_configuring-profile-settings.adoc
  • docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc

Comment thread docs/topics/vscode/proc_configuring-profile-settings.adoc Outdated
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@Pkylas007 Pkylas007 requested a review from rromannissen June 25, 2026 17:02
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@Pkylas007

Copy link
Copy Markdown
Collaborator Author

@rromannissen Please review the prerequisites necessary for the profile sync. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant