Skip to content

Updates to IDE documentation following release of VS Code extension guide #455

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.

Sign up for GitHub

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

Merged
apinnick merged 3 commits into from
Oct 7, 2021
Merged

Updates to IDE documentation following release of VS Code extension guide #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
855aad3
Updates to IDE documentation following publication of the VS Code ext…
RichardHoch Oct 5, 2021
695b814
Minor
RichardHoch Oct 7, 2021
bdac886
VS code fix
RichardHoch Oct 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/getting-started-guide/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ include::topics/about-cli.adoc[leveloffset=+2]
include::topics/about-the-web-console.adoc[leveloffset=+2]

// About the {PluginNameTitle}
include::topics/about-plugin.adoc[leveloffset=+2]
include::topics/eclipse-about-plugin.adoc[leveloffset=+2]

// About the VS Code extension
include::topics/about-vscode-extension.adoc[leveloffset=+2]

// About the {MavenNameTitle}
include::topics/about-maven.adoc[leveloffset=+2]
Expand Down
8 changes: 0 additions & 8 deletions docs/topics/about-plugin.adoc
View file
Open in desktop

This file was deleted.

9 changes: 5 additions & 4 deletions docs/topics/about-tools.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

The {ProductName} ({ProductShortName}) provides several tools to assist you in the various stages of your migration and modernization efforts. Review the details of each tool to determine which is right for your project.

* link:{ProductDocUserGuideURL}[{CLINameTitle}]
* link:{ProductDocWebConsoleGuideURL}[{WebNameTitle}]
* link:{EclipseCrsGuideURL}[{EclipseCrsGuideTitle}]
* link:{ProductDocMavenGuideURL}[{MavenNameTitle}]
* CLI
* Web console
* {PluginName} for Eclipse and Red Hat CodeReady Studio
* {ProductShortName} extension for Visual Studio Code
* {MavenName}
10 changes: 8 additions & 2 deletions docs/topics/about-vscode-extension.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,18 @@


[id='about-vscode-extension_{context}']
= About the {ProductName} extension for Visual Studio Code
= About the {ProductShortName} extension for Visual Studio Code

The {ProductName} ({ProductShortName}) extension provides assistance directly in Visual Studio Code for developers migrating or modernizing projects that contain Java applications.
The {ProductName} ({ProductShortName}) extension for Visual Studio Code helps you migrate and modernize applications.

The {ProductShortName} extension is also compatible with Visual Studio Codespaces, the Microsoft cloud-hosted development environment.

The {ProductShortName} extension analyzes your projects using customizable rulesets, marks issues in the source code, provides guidance to fix the issues, and offers automatic code replacement, if possible.

ifdef::getting-started-guide[]
For more information about using the {ProductShortName} extension, see the {ProductShortName} link:{ProductDocVscGuideURL}[_Visual Studio Code Extension Guide_].
endif::[]

[IMPORTANT]
====
The {ProductName} ({ProductShortName}) extension for Visual Studio Code is provided as a Technology Preview only. Technology Preview features provide early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process. However, these features are not fully supported under Red Hat Subscription Level Agreements, may not be functionally complete, and are not intended for production use.
Expand Down
13 changes: 11 additions & 2 deletions docs/topics/eclipse-about-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
// Module included in the following assemblies:
//
// * docs/getting-started-guide/master.adoc
// * docs/eclipse-code-ready-studio-guide/master.adoc

[id="eclipse-about-plugin_{context}"]
= About the {PluginName}
= About the {PluginName} for Eclipse and Red Hat CodeReady Studio

The {PluginName} for the {ProductName} provides assistance directly in Eclipse and Red Hat CodeReady Studio for developers making changes for a migration or modernization effort.
The {ProductName} ({ProductShortName}) plugin for Eclipse and Red Hat CodeReady Studio helps you migrate and modernize applications.

The {PluginName} analyzes your projects using customizable rulesets, marks migration issues in the source code, provides guidance to fix the issues, and offers automatic code replacement, or Quick Fixes, if possible.

ifdef::eclipse-code-ready-studio-guide[]
For information about a similar extension for Visual Studio Code, see the link:{ProductDocVscGuideURL}[_Visual Studio Code Extension Guide_].
endif::[]

ifdef::getting-started-guide[]
For more information on using the {PluginName}, see the MTA link:{EclipseCrsGuideURL}[_{EclipseCrsGuideTitle}_].
endif::[]