-
Notifications
You must be signed in to change notification settings - Fork 8
[WIP] Mod docs + DITA preps work for the VSCode Guide #170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mpershina
wants to merge
7
commits into
main
Choose a base branch
from
vscode-guide_mod-work
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
30eadd4
Mod docs work for the VSCode Guide
b68a09d
Apply suggestions from code review
mpershina a789b3f
fixed xrefs
mpershina caef8f2
Peer review applied
mpershina 2a4013b
added a synlink to images
mpershina 8b27d69
Dita fixes
mpershina b875097
minor fixes
mpershina File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
:_newdoc-version: 2.18.5 | ||
:_template-generated: 2025-07-21 | ||
:_mod-docs-content-type: CONCEPT | ||
|
||
[id="intro-to-vscode-for-mta_{context}"] | ||
= Introduction to the {ProductShortName} extension for Microsoft Visual Code | ||
|
||
You can migrate and modernize applications by using the {ProductName} ({ProductShortName}) {AddonType} for {IDEName}. | ||
|
||
The {ProductShortName} {AddonType} can perform the following actions: | ||
|
||
* Analyze your projects with customizable rulesets. | ||
* Mark issues in the source code. | ||
* Provide guidance to fix the issues. | ||
* Perform automatic code replacement, if possible. | ||
|
||
ifdef::vsc-extension-guide[] | ||
The {ProductShortName} extension is also compatible with Visual Studio Codespaces, the Microsoft cloud-hosted development environment. | ||
endif::[] | ||
|
||
ifdef::idea-plugin-guide[] | ||
The {AddonType} supports both the Community Edition and the Ultimate version of {IDEName}. | ||
endif::[] | ||
|
||
|
||
// This module can be reused in the following files, if needed: | ||
// | ||
// * docs/intellij-idea-plugin-guide/master.adoc | ||
// * docs/eclipse-code-ready-guide/master.adoc |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
:_mod-docs-content-type: CONCEPT | ||
[id="vscode-extension-interface_{context}"] | ||
= {ProductShortName} Visual Studio Code extension interface | ||
|
||
The interface of the {ProductName} ({ProductShortName}) extension for Visual Studio Code is designed to make it easier for you to find information and perform the required actions: | ||
|
||
* In the left pane, you can see the *Analysis Results* directory tree that includes the following elements: | ||
|
||
** A report icon. You can click the icon to open the {ProductShortName} report in your browser. | ||
** The applications analyzed by {ProductShortName}. | ||
** The rulesets used for the analysis. | ||
** The issues discovered by the analysis. | ||
|
||
* In the upper right pane, you can configure an analysis. | ||
* In the lower right pane, you can see the settings of the configuration, including source, target, and advanced options. You can view the progress of an analysis in this pane. When the analysis is completed, you can click the *Open Report* button to open the {ProductShortName} report, which describes any issues you need to address before you migrate or modernize your application. For more information, see link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.3/html-single/cli_guide/index#reviewing-analysis-reports_cli-guide[Reviewing an analysis report]. | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../images/ |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
:_mod-docs-content-type: PROCEDURE | ||
[id="installing-vscode-extension_{context}"] | ||
= Installing the {ProductShortName} extension for Visual Studio Code | ||
|
||
[role="_abstract"] | ||
You can install the {ProductShortName} extension for Visual Studio Code (VS Code). | ||
|
||
.Prerequisites | ||
|
||
* You installed the Java Development Kit (JDK). {ProductShortName} supports the following JDKs: | ||
|
||
** Oracle JDK 17 or later | ||
** Eclipse Temurin™ JDK 17 or later | ||
** OpenJDK 17 or later | ||
|
||
* You have 8 GB of RAM available. | ||
|
||
* For macOS installation, you have the value of `maxproc` set to `2048` or greater. | ||
|
||
.Procedure | ||
|
||
. Set the `JAVA_HOME` environmental variable: | ||
+ | ||
[subs="+quotes"] | ||
.... | ||
$ *export JAVA_HOME=jdk11* | ||
.... | ||
|
||
. In VS Code, click the *Extensions* icon on the *Activity* bar to open the *Extensions* view. | ||
. Enter `{ProductName}` in the Search field. | ||
mpershina marked this conversation as resolved.
Show resolved
Hide resolved
|
||
. Select the *{ProductName}* extension and click *Install*. | ||
+ | ||
The {ProductShortName} extension icon (image:vs_extension_icon.png[{ProductShortName} code extension]) is displayed on the Activity bar. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
:_mod-docs-content-type: PROCEDURE | ||
[id="vscode-analyzing-application_{context}"] | ||
= Configuring and running an application analysis | ||
|
||
[role="_abstract"] | ||
To analyze an application with the {ProductShortName} extension for Visual Studio Code, you must create a run configuration first. You can configure multiple run configurations to run against each project you import to Visual Studio Code. | ||
|
||
.Prerequisites | ||
|
||
* You installed the `{mta-cli}` executable. You can download `{mta-cli}` from the link:https://developers.redhat.com/products/mta/download[{ProductShortName} download page]. | ||
|
||
.Procedure | ||
|
||
. In *Extensions* view, click the {ProductName} icon (image:vs_extension_icon.png[{ProductShortName} code extension]) on the *Activity* bar. | ||
mpershina marked this conversation as resolved.
Show resolved
Hide resolved
|
||
. Click the plus sign (*+*) next to *{ProductName}* to add a run configuration. | ||
. Specify the following configuration fields: | ||
|
||
** *Name*: Enter a name for the analysis configuration or accept the default suggestion. | ||
|
||
** *cli*: Enter the path to the `{mta-cli}` executable, for example: `$HOME/{mta-cli}-{ProductDistributionVersion}/bin/{mta-cli}`. | ||
|
||
** *Input*: Set to the path of the project that you have open within your IDE: | ||
|
||
... Click *Add*. | ||
... Perform one of the following actions: | ||
|
||
**** Enter the input file or directory and press *Enter*. | ||
**** Click *Open File Explorer* and select the directory. | ||
|
||
** *Target*: Select one or more target migration paths. | ||
|
||
. Right-click the run configuration and select *Run*. | ||
+ | ||
When the analysis is completed, you can click the *Open Report* button to open the {ProductShortName} report, which describes the issues you need to address before you migrate or modernize your application. For more information, see link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.3/html-single/cli_guide/index#reviewing-analysis-reports_cli-guide[Reviewing an analysis report]. |
36 changes: 36 additions & 0 deletions
36
docs/topics/vscode/proc_vscode-reviewing-and-resolving-issues.adoc
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
:_mod-docs-content-type: PROCEDURE | ||
[id="vscode-reviewing-and-resolving-issues_{context}"] | ||
= Reviewing and resolving migration issues | ||
|
||
[role="_abstract"] | ||
You can use the {ProductShortName} extension icons to prioritize issues based on their severity. | ||
|
||
.Procedure | ||
|
||
. Select a run configuration directory on the left pane. | ||
. Expand its folders to view the *Hints* generated for each application file. | ||
. Select a hint to view the source code. | ||
. Right-click a hint and select *View Details* to view the Rule ID and other information. | ||
. Prioritize issues based on the following icons, which are displayed next to each hint: | ||
|
||
** image:vs_mandatory.png[Mandatory]: You must fix the issue for a successful migration. | ||
** image:vs_potential.png[Warning]: You might need to address the issue during the migration. | ||
mpershina marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
. Resolve issues by editing the code of a file with a hint: | ||
|
||
.. In the left pane, right-click an issue and select *Open Code*. | ||
.. Make any changes needed to the code and save the file. | ||
.. Optional: Right-click the issue and select *Mark as Complete* or *Delete*. | ||
|
||
//// | ||
== Using a Quick Fix | ||
|
||
You can use a Quick Fix automatic code replacement to save time and ensure consistency in resolving repetitive issues. | ||
|
||
.Procedure | ||
|
||
. In the left pane, right-click an issue that has the Quick Fix icon (image:vs_optional.png[Optional or Quick Fix]) and select *Preview Quick Fix*. | ||
. To accept the suggested fix, right-click the issue again and select *Apply Quick Fix*. | ||
. Optional: Right-click the issue and select *Mark as Complete* or *Delete*. | ||
//// | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../assemblies/ |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.