[MTA-6933] Visual Studio Code MTA plugin installation options

[Pkylas007]

Version

• 8.1.1

JIRA

• https://redhat.atlassian.net/browse/MTA-6933

Preview

• 2. Installing the MTA extension for Visual Studio Code

Summary by CodeRabbit

• Documentation
  • Rewrote VS Code extension installation guidance to present two install options: full extension pack or core + language-specific extensions for lower memory usage
  • Listed supported language extensions (Java, JavaScript/Node.js, C#, Go) and added a “Developer Preview features only” warning
  • Removed prior Lightspeed enablement note and moved Marketplace, configuration, and support links into an “Additional resources” section

[coderabbitai]

📝 Walkthrough

Walkthrough

The VS Code extension installation doc was rewritten to present two options—install the {ProductFullName} extension pack or use {ProductShortName} Core plus language-specific plugins—adds a Developer Preview warning for language extensions, and moves external links into an Additional resources subsection.

Changes

VS Code Extension Installation Documentation

Layer / File(s)

Summary

Installation procedure and resource reorganization docs/topics/vscode/proc_installing-vscode-extension.adoc

Installation guidance now describes two approaches: the {ProductFullName} extension pack (all languages) versus the {ProductShortName} Core plugin with language-specific extensions (memory-optimized). A language extension list and [IMPORTANT] Developer Preview notice were added. The plugin step no longer contains an inline Marketplace URL; Marketplace, Developer Lightspeed configuration, and Developer Preview Support Scope links were relocated to an "Additional resources" subsection.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• migtools/mta-documentation#315: Edits the same VS Code extension installation guide and adjusts Marketplace/branding wording.
• migtools/mta-documentation#339: Also modifies the VS Code installation guide, changing Marketplace link text.
• migtools/mta-documentation#311: Rewrote installation instructions around extension pack vs Core+language plugins and repositioned Lightspeed guidance.

Suggested reviewers

• mpershina
• djzager
• abrugaro

Poem

🐇 I hopped through docs with nimble feet,
Rewrote the steps for installs complete,
Two paths for plugins, tidy and neat,
Links gathered where resources meet,
Now setups finish quick and sweet. 🎉

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Title check	✅ Passed	The title clearly and specifically describes the main change: updating VS Code MTA plugin installation documentation to present multiple installation options (extension pack vs. core + language-specific).
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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 mta-vscode-extension-pack

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

docs/topics/vscode/proc_installing-vscode-extension.adoc (1)

15-15: ⚡ Quick win

Reconsider backticks around "Extension pack".

Backticks typically denote code or monospace text in AsciiDoc. Since "Extension pack" is a product name rather than code, consider removing the backticks or using appropriate emphasis markup if needed.

📝 Suggested adjustment

-:FeatureName: `Extension pack`, `C#`, `Javascript`, and `Go` extensions
+:FeatureName: Extension pack, `C#`, `JavaScript`, and `Go` extensions

🤖 Prompt for 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.

In `@docs/topics/vscode/proc_installing-vscode-extension.adoc` at line 15, The
frontmatter attribute :FeatureName: currently wraps "Extension pack" in
backticks, which are code-style in AsciiDoc; update the attribute value to
remove the backticks around Extension pack (e.g., change `Extension pack` to
Extension pack) or replace them with appropriate emphasis (e.g., _Extension
pack_ or *Extension pack*) so the product name is not rendered as code; edit the
:FeatureName: attribute where it's defined to apply this change.

🤖 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_installing-vscode-extension.adoc`:
- Line 11: The phrase uses incorrect capitalization for proper nouns: replace
occurrences of "Javascript" and "javascript" with "JavaScript" and change
"node.js" to "Node.js" in the line containing "* `Javascript` to analyze
`javascript` and `node.js` applications" so the docs read "* `JavaScript` to
analyze `JavaScript` and `Node.js` applications".
- Line 6: The sentence uses the awkward phrase "optimize the extension memory";
update the wording in the sentence that starts "Install the {ProductFullName}
extension pack..." to use clearer language such as "optimize memory usage" or
"reduce memory footprint" (e.g., "Use the extension pack to analyze in all
supported languages or the *Core* and a language-specific plugin to reduce
memory footprint.") so the intent is clear and reads naturally.

---

Nitpick comments:
In `@docs/topics/vscode/proc_installing-vscode-extension.adoc`:
- Line 15: The frontmatter attribute :FeatureName: currently wraps "Extension
pack" in backticks, which are code-style in AsciiDoc; update the attribute value
to remove the backticks around Extension pack (e.g., change `Extension pack` to
Extension pack) or replace them with appropriate emphasis (e.g., _Extension
pack_ or *Extension pack*) so the product name is not rendered as code; edit the
:FeatureName: attribute where it's defined to apply this change.

🪄 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: b65e775c-cf87-4209-8f64-cf41a6b962c9

📥 Commits

Reviewing files that changed from the base of the PR and between fd7cbc6 and 42bc16d.

📒 Files selected for processing (1)

• docs/topics/vscode/proc_installing-vscode-extension.adoc

[Pkylas007]

@mpershina Can you please give this installation topic a quick review? Thanks!

[mpershina]

Minor changes needed.

[Pkylas007]

Minor changes needed.

Done, thanks!

[anarnold97]

@Pkylas007 - please do a sync and publish. thanks

[Pkylas007]

@Pkylas007 - please do a sync and publish. thanks
Thanks very much for looking into it on such a short notice!