From 855aad33f098b26291c6eba9db784eeb594f2da3 Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Tue, 5 Oct 2021 15:08:52 +0300 Subject: [PATCH 1/3] Updates to IDE documentation following publication of the VS Code extension guide --- docs/getting-started-guide/master.adoc | 5 ++++- docs/topics/about-plugin.adoc | 8 -------- docs/topics/about-tools.adoc | 9 +++++---- docs/topics/about-vscode-extension.adoc | 8 ++++++-- docs/topics/eclipse-about-plugin.adoc | 13 +++++++++++-- 5 files changed, 26 insertions(+), 17 deletions(-) delete mode 100644 docs/topics/about-plugin.adoc diff --git a/docs/getting-started-guide/master.adoc b/docs/getting-started-guide/master.adoc index 42664e5ac7..b053b20468 100644 --- a/docs/getting-started-guide/master.adoc +++ b/docs/getting-started-guide/master.adoc @@ -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] diff --git a/docs/topics/about-plugin.adoc b/docs/topics/about-plugin.adoc deleted file mode 100644 index 7d80337a29..0000000000 --- a/docs/topics/about-plugin.adoc +++ /dev/null @@ -1,8 +0,0 @@ -// Module included in the following assemblies: -// -// * docs/getting-started-guide/master.adoc - -[id="about-plugin_{context}"] -= About the {PluginName} - -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. It analyzes your projects using {ProductShortName}, marks migration issues in the source code, provides guidance to fix the issues, and offers automatic code replacement when possible. diff --git a/docs/topics/about-tools.adoc b/docs/topics/about-tools.adoc index d55cabf012..03027648dd 100644 --- a/docs/topics/about-tools.adoc +++ b/docs/topics/about-tools.adoc @@ -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} diff --git a/docs/topics/about-vscode-extension.adoc b/docs/topics/about-vscode-extension.adoc index 8d39780034..3741d77ede 100644 --- a/docs/topics/about-vscode-extension.adoc +++ b/docs/topics/about-vscode-extension.adoc @@ -4,12 +4,16 @@ [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 provides assistance directly in Visual Studio Code for developers migrating or modernizing projects that contain Java applications. The {ProductShortName} extension is 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. diff --git a/docs/topics/eclipse-about-plugin.adoc b/docs/topics/eclipse-about-plugin.adoc index c011d84867..5a838e4b42 100644 --- a/docs/topics/eclipse-about-plugin.adoc +++ b/docs/topics/eclipse-about-plugin.adoc @@ -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::[] From 695b8141fdb16305751231372c65cdd4093f4f6b Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Thu, 7 Oct 2021 12:57:33 +0300 Subject: [PATCH 2/3] Minor --- docs/topics/about-vscode-extension.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/topics/about-vscode-extension.adoc b/docs/topics/about-vscode-extension.adoc index 3741d77ede..87108539dd 100644 --- a/docs/topics/about-vscode-extension.adoc +++ b/docs/topics/about-vscode-extension.adoc @@ -6,7 +6,9 @@ [id='about-vscode-extension_{context}'] = 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 {ProductShortName} extension is compatible with Visual Studio Codespaces, the Microsoft cloud-hosted development environment. +The {ProductName} ({ProductShortName}) extension provides assistance directly in Visual Studio Code for developers migrating or modernizing projects that contain Java 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. From bdac88635ec17b69dd77bae101dac125bb3ad6f4 Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Thu, 7 Oct 2021 13:31:32 +0300 Subject: [PATCH 3/3] VS code fix --- docs/topics/about-vscode-extension.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/about-vscode-extension.adoc b/docs/topics/about-vscode-extension.adoc index 87108539dd..086fa2ae3c 100644 --- a/docs/topics/about-vscode-extension.adoc +++ b/docs/topics/about-vscode-extension.adoc @@ -6,7 +6,7 @@ [id='about-vscode-extension_{context}'] = 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.