Skip to content

Commit b58f728

Browse files
anarnold97anarnold97
committed
Updating
Signed-off-by: Andy Arnold <[email protected]>
1 parent 989004d commit b58f728

17 files changed

+440
-16
lines changed

‎docs/getting-started-guide-mtr/master.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ include::topics/making-open-source-more-inclusive.adoc[]
1717
== Introduction
1818

1919
// About the {IntroToMTABookName}
20-
include::topics/about-the-intro-to-mta-guide.adoc[leveloffset=+2]
20+
include::topics/mtr-about-the-intro-to-mta-guide.adoc[leveloffset=+2]
2121

2222
// About the Toolkit
2323
include::topics/mtr-what-is-the-toolkit.adoc[leveloffset=+1]
2424

2525
// Windup Features
26-
include::topics/features.adoc[leveloffset=+2]
26+
include::topics/mtr-features.adoc[leveloffset=+2]
2727

2828
// Windup Rules
29-
include::topics/about-rules.adoc[leveloffset=+2]
29+
include::topics/mtr-about-rules.adoc[leveloffset=+2]
3030

3131
== Supported configurations
3232

3333
// Supported Migration Paths
34-
include::topics/migration-paths.adoc[leveloffset=+2]
34+
include::topics/mtr-migration-paths.adoc[leveloffset=+2]
3535

3636
// Prerequisites
3737
== Prerequisites
@@ -40,45 +40,45 @@ include::topics/snippet_jdk-hardware-mac-prerequisites.adoc[]
4040
// At a later date, we may wish to add the following section, once it is revised: For tips on how to optimize performance, see link:{ProductDocUserGuideURL}#optimize_performance[Optimizing {ProductShortName} performance] in {ProductShortName} _{UserCLIBookName}_.
4141

4242
// About the Tools
43-
include::topics/about-tools.adoc[leveloffset=+1]
43+
include::topics/mtr-about-tools.adoc[leveloffset=+1]
4444

4545
// About the {CLIName}
4646
include::topics/mtr-about-cli.adoc[leveloffset=+2]
4747

4848
// About the {WebNameTitle}
49-
include::topics/about-the-web-console.adoc[leveloffset=+2]
49+
include::topics/mtr-about-the-web-console.adoc[leveloffset=+2]
5050

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

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

5757
// About the {MavenNameTitle}
58-
include::topics/about-maven.adoc[leveloffset=+2]
58+
include::topics/mtr-about-maven.adoc[leveloffset=+2]
5959

6060
== Planning your application migration
6161

6262
// Goals of Assessing a Migration
63-
include::topics/migration-goals.adoc[leveloffset=+2]
63+
include::topics/mtr-migration-goals.adoc[leveloffset=+2]
6464

6565
// Red Hat's Application Migration Approach
66-
include::topics/migration-approach.adoc[leveloffset=+2]
66+
include::topics/mtr-migration-approach.adoc[leveloffset=+2]
6767

6868
// Best Practices
69-
include::topics/migration-best-practices.adoc[leveloffset=+3]
69+
include::topics/mtr-migration-best-practices.adoc[leveloffset=+3]
7070

7171
// Migration Methodology
72-
include::topics/migration-methodology.adoc[leveloffset=+3]
72+
include::topics/mtr-migration-methodology.adoc[leveloffset=+3]
7373

7474
// Discover Phase
75-
include::topics/method-discover.adoc[leveloffset=+4]
75+
include::topics/mtr-method-discover.adoc[leveloffset=+4]
7676

7777
// Design Phase
78-
include::topics/method-design.adoc[leveloffset=+4]
78+
include::topics/mtr-method-design.adoc[leveloffset=+4]
7979

8080
// Deploy Phase
81-
include::topics/method-deploy.adoc[leveloffset=+4]
81+
include::topics/mtr-method-deploy.adoc[leveloffset=+4]
8282

8383
[appendix]
8484
== Reference material

‎docs/topics/mtr-about-maven.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/maven-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="about-maven_{context}"]
7+
= About the {MavenNameTitle}
8+
9+
The {MavenName} for the {ProductName} integrates into the Maven build process, allowing developers to continuously evaluate migration and modernization efforts with each iteration of source code. It provides numerous reports that highlight the analysis results, and is designed for developers who want updates with each build.

‎docs/topics/mtr-about-rules.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/rules-development-guide/master.adoc
4+
// * docs/getting-started-guide/master.adoc
5+
6+
:_content-type: CONCEPT
7+
[id="about-rules_{context}"]
8+
= About {ProductShortName} rules
9+
10+
The {ProductName} ({ProductShortName}) contains rule-based migration tools that analyze the APIs, technologies, and architectures used by the applications you plan to migrate. In fact, the {ProductShortName} analysis process is implemented using {ProductShortName} rules. {ProductShortName} uses rules internally to extract files from archives, decompile files, scan and classify file types, analyze XML and other file content, analyze the application code, and build the reports.
11+
12+
{ProductShortName} builds a data model based on the rule execution results and stores component data and relationships in a graph database, which can then be queried and updated as needed by the migration rules and for reporting purposes.
13+
14+
{ProductShortName} rules use the following rule pattern:
15+
16+
----
17+
when(condition)
18+
perform(action)
19+
otherwise(action)
20+
----
21+
22+
{ProductShortName} provides a comprehensive set of standard migration rules out-of-the-box. Because applications may contain custom libraries or components, {ProductShortName} allows you to write your own rules to identify use of components or software that may not be covered by the existing ruleset.
23+
24+
ifndef::rules-development-guide[]
25+
If you plan to write your own custom rules, see the {ProductDocRulesGuideURL}[_{RulesDevBookName}_] for detailed instructions.
26+
endif::rules-development-guide[]

‎docs/topics/mtr-about-the-intro-to-mta-guide.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/getting-started-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="about-the-intro-to-mta-guide_{context}"]
7+
= About the {IntroToMTABookName}
8+
9+
This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications or other components. It provides an overview of the {ProductName} and how to get started using the tools to plan and run your migration.

‎docs/topics/mtr-about-the-web-console.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="about-the-web-console_{context}"]
7+
= About the {WebName}
8+
9+
The {WebName} for the {ProductName} allows a team of users to assess and prioritize migration and modernization efforts for a large number of applications. It allows you to group applications into projects for analysis and provides numerous reports that highlight the results.
10+

‎docs/topics/mtr-about-tools.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/cli-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="about-tools_{context}"]
7+
= About the tools
8+
9+
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 one is right for your project.
10+
11+
ifdef::mta[]
12+
* User interface
13+
endif::[]
14+
15+
ifdef::mtr[]
16+
* Web console
17+
endif::[]
18+
19+
* {ProductName} Operator
20+
* CLI
21+
* IDE addons for:
22+
** Eclipse
23+
** Visual Studio Code, Visual Studio Codespaces, and Eclipse Che
24+
** IntelliJ IDEA
25+
* {MavenName}

‎docs/topics/mtr-about-vscode-extension.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/vs-code-extension-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id='about-vscode-extension_{context}']
7+
= About the {ProductShortName} extension for Visual Studio Code
8+
9+
The {ProductName} ({ProductShortName}) extension for Visual Studio Code helps you migrate and modernize applications.
10+
11+
The {ProductShortName} extension is also compatible with Visual Studio Codespaces, the Microsoft cloud-hosted development environment.
12+
13+
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.
14+
15+
ifdef::getting-started-guide[]
16+
For more information about using the {ProductShortName} extension, see the {ProductShortName} link:{ProductDocVscGuideURL}[_Visual Studio Code Extension Guide_].
17+
endif::[]

‎docs/topics/mtr-eclipse-about-plugin.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/getting-started-guide/master.adoc
4+
// * docs/eclipse-code-ready-studio-guide/master.adoc
5+
6+
:_content-type: CONCEPT
7+
[id="eclipse-about-plugin_{context}"]
8+
= About the {PluginName} for Eclipse
9+
10+
The {ProductName} ({ProductShortName}) plugin for Eclipse helps you migrate and modernize applications.
11+
12+
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.
13+
14+
ifdef::eclipse-code-ready-studio-guide[]
15+
For information about a similar extension for Visual Studio Code, see the link:{ProductDocVscGuideURL}[_Visual Studio Code Extension Guide_].
16+
endif::[]
17+
18+
ifdef::getting-started-guide[]
19+
For more information on using the {PluginName}, see the {ProductShortName} link:{EclipseCrsGuideURL}[_{EclipseCrsGuideTitle}_].
20+
endif::[]

‎docs/topics/mtr-features.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/getting-started-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="features_{context}"]
7+
= {ProductShortName} Features
8+
9+
The {ProductName} ({ProductShortName}) provides a number of capabilities to assist with planning and executing migration projects.
10+
11+
Planning and work estimation::
12+
{ProductShortName} assists project managers by detailing the type of work and estimation of effort to complete the tasks. Level of effort is represented in {ProductShortName} reports as story points. Actual estimates will be based on the skills required and the classification of migration work needed.
13+
14+
Identifying migration issues and providing solutions::
15+
{ProductShortName} identifies migration issues and highlights specific points in the code where an issue occurs. {ProductShortName} suggests code changes and provides additional resources to help engineers resolve the specific issue.
16+
17+
Detailed reporting::
18+
{ProductShortName} produces numerous reports to give both high-level views of the migration effort and details of specific migration tasks. You can view migration issues across all applications, charts and summary information about issues in an application, a breakdown of issues by module in the application, reports of technologies used, and dependencies on other applications and services. You can also examine source files to see the line of code where an issue occurs. See the link:{ProductDocUserGuideURL}[_{UserCLIBookName}_] for more information on the available {ProductShortName} reports.
19+
20+
Built-in rules and migration paths::
21+
{ProductShortName} comes with a core set of rules to provide migration assistance for several common migration paths. These rules identify the use of proprietary functionality from other application servers or deprecated subsystems from previous versions of JBoss EAP. {ProductShortName} also contains rules to identify common migration issues, such as hard-coded IP addresses and JNDI lookups.
22+
23+
Rule extensibility and customization::
24+
{ProductShortName} provides the ability to create powerful and complex rules. You can expand upon the core set of rules provided by {ProductShortName} and create rules to identify additional issues that are important for your migration project. You can also override core rules and create custom rule categories. See the link:{ProductDocRulesGuideURL}[_{RulesDevBookName}_] for more information on customizing {ProductShortName} rules.
25+
26+
Ability to analyze source code or application archives::
27+
{ProductShortName} can evaluate application archives or source code, and can evaluate multiple applications together. It can identify archives that are shared across multiple applications, which can help with more accurate effort estimation.

‎docs/topics/mtr-method-deploy.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/getting-started-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="method-deploy_{context}"]
7+
= Deploy phase
8+
9+
.Red Hat migration methodology: Deploy phase
10+
image::RHAMT_AMM_Methodology_446947_0617_ECE_Deploy.png[Red Hat migration methodology: Deploy]
11+
12+
The _Deploy_ phase is when you run the plan created in the Design phase. In this phase, you scale the overall transformation process to complete the plan and bring all applications to their new production environment.
13+
14+
The plan is run in iterations to deliver value incrementally. With each iteration, you continuously validate against the plan and document findings to improve the next sprint.
15+
16+
The use of the {ProductName} {PluginName} increases speed in each iteration. It can be used with Eclipse, and marks migration issues directly in the source code, provides inline hints, and offers code change suggestions. See the link:{EclipseCrsGuideURL}[_{EclipseCrsGuideTitle}_] for information on how to use the {PluginName}.

0 commit comments

Comments
 (0)