Skip to content

Commit

Permalink
MTA-2257: Diverging MTA and MTR documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Andy Arnold <anarnold@redhat.com>
  • Loading branch information
anarnold97 committed Feb 18, 2024
1 parent 8e246ee commit f1cdd95
Show file tree
Hide file tree
Showing 55 changed files with 2,320 additions and 64 deletions.
34 changes: 17 additions & 17 deletions docs/cli-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,67 +17,67 @@ include::topics/making-open-source-more-inclusive.adoc[]
== Introduction

// About the {UserCLIBookName}
include::topics/about-cli-guide.adoc[leveloffset=+2]
include::topics/mtr-about-cli-guide.adoc[leveloffset=+2]

// About {ProductName}
include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
include::topics/mtr-what-is-the-toolkit.adoc[leveloffset=+2]

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

== Installing and Running the CLI

// Install the CLI
include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2]
include::topics/mtr-installing-web-console-or-cli-tool.adoc[leveloffset=+2]

// Run the CLI
include::topics/cli-run.adoc[leveloffset=+2]

// Use OpenRewrite recipes
include::topics/using-openrewrite-recipes.adoc[leveloffset=+3]
include::topics/mtr-using-openrewrite-recipes.adoc[leveloffset=+3]

// Available OpenRewrite recipes
include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
include::topics/mtr-available-openrewrite-recipes.adoc[leveloffset=+4]

// Access the Report
include::topics/access-report.adoc[leveloffset=+2]
include::topics/mtr-access-report.adoc[leveloffset=+2]

// Review the Reports
include::topics/review-reports.adoc[leveloffset=+1]
include::topics/mtr-review-reports.adoc[leveloffset=+1]

// Export the Report in CSV Format
include::topics/csv-export.adoc[leveloffset=+1]
include::topics/mtr-csv-export.adoc[leveloffset=+1]

// Mavenize Your Application
include::topics/mavenize.adoc[leveloffset=+1]
include::topics/mtr-mavenize.adoc[leveloffset=+1]

// Optimize {ProductShortName} Performance
include::topics/optimize-performance.adoc[leveloffset=+1]
include::topics/mtr-optimize-performance.adoc[leveloffset=+1]

// Configure {ProductShortName} to Exclude Files and Packages
include::topics/exclude-files-and-packages.adoc[leveloffset=+2]
include::topics/mtr-exclude-files-and-packages.adoc[leveloffset=+2]

[appendix]
== Reference material

// {ProductShortName} Command-line Arguments
include::topics/cli-args.adoc[leveloffset=+2]
include::topics/mtr-cli-args.adoc[leveloffset=+2]

// Added in 4.3.0: list of supported Tech Tags
include::topics/tech-tags.adoc[leveloffset=+2]
include::topics/mtr-tech-tags.adoc[leveloffset=+2]

// Rule Story Points
include::topics/about-story-points.adoc[leveloffset=+2]
include::topics/mtr-about-story-points.adoc[leveloffset=+2]

For more information on categorizing tasks, see link:{ProductDocRulesGuideURL}/rule_categories_rules-development-guide#rule_categories_rules-development-guide[Using custom rule categories].

=== Additional Resources

// Get Involved
include::topics/get-involved.adoc[leveloffset=+3]
include::topics/mtr-get-involved.adoc[leveloffset=+3]

// Important Links
include::topics/important-links.adoc[leveloffset=+3]
include::topics/mtr-important-links.adoc[leveloffset=+3]

// Report Issues with {ProductShortName}

Expand Down
26 changes: 13 additions & 13 deletions docs/eclipse-code-ready-studio-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,29 @@ include::topics/making-open-source-more-inclusive.adoc[]
[id="introduction_{context}"]
== Introduction

include::topics/about-ide-addons.adoc[leveloffset=+2]
include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
include::topics/mtr-about-ide-addons.adoc[leveloffset=+2]
include::topics/mtr-what-is-the-toolkit.adoc[leveloffset=+2]

[id="installing-plugin_{context}"]
== Installing and configuring the {PluginName}

You can install the {PluginName} and configure it to use the {ProductShortName} CLI for analysis execution.

include::topics/eclipse-installing-plugin.adoc[leveloffset=+2]
include::topics/mtr-eclipse-installing-plugin.adoc[leveloffset=+2]

include::topics/eclipse-configuring-plugin-for-cli.adoc[leveloffset=+2]
include::topics/mtr-eclipse-configuring-plugin-for-cli.adoc[leveloffset=+2]

include::topics/eclipse-accessing-tools.adoc[leveloffset=+1]
include::topics/mtr-eclipse-accessing-tools.adoc[leveloffset=+1]

[id="analyzing-projects-with-plugin_{context}"]
== Analyzing your projects with the {PluginName}

You can analyze your projects with the {PluginName} by creating a run configuration, running an analysis, and then reviewing and resolving migration issues detected by the {PluginName}.

include::topics/eclipse-configuring-run.adoc[leveloffset=+2]
include::topics/eclipse-analyzing-projects.adoc[leveloffset=+2]
include::topics/eclipse-reviewing-issues.adoc[leveloffset=+2]
include::topics/eclipse-resolving-issues.adoc[leveloffset=+2]
include::topics/mtr-eclipse-configuring-run.adoc[leveloffset=+2]
include::topics/mtr-eclipse-analyzing-projects.adoc[leveloffset=+2]
include::topics/mtr-eclipse-reviewing-issues.adoc[leveloffset=+2]
include::topics/mtr-eclipse-resolving-issues.adoc[leveloffset=+2]

// TODO: Uncomment when uninstalling works and this is ready
// include::topics/plugin-uninstall.adoc[leveloffset=+1]
Expand All @@ -55,9 +55,9 @@ The {PluginName} comes with a core set of *System* rules for analyzing projects

You can create and import custom rulesets.

include::topics/eclipse-viewing-rules.adoc[leveloffset=+2]
include::topics/eclipse-creating-custom-ruleset.adoc[leveloffset=+2]
include::topics/eclipse-importing-custom-ruleset.adoc[leveloffset=+2]
include::topics/eclipse-submitting-ruleset.adoc[leveloffset=+2]
include::topics/mtr-eclipse-viewing-rules.adoc[leveloffset=+2]
include::topics/mtr-eclipse-creating-custom-ruleset.adoc[leveloffset=+2]
include::topics/mtr-eclipse-importing-custom-ruleset.adoc[leveloffset=+2]
include::topics/mtr-eclipse-submitting-ruleset.adoc[leveloffset=+2]

:!eclipse-code-ready-studio-guide:
40 changes: 20 additions & 20 deletions docs/getting-started-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ include::topics/making-open-source-more-inclusive.adoc[]
== Introduction

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

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

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

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

== Supported configurations

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

// Prerequisites
== Prerequisites
Expand All @@ -40,56 +40,56 @@ include::topics/snippet_jdk-hardware-mac-prerequisites.adoc[]
// 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}_.

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

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

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

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

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

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

== Planning your application migration

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

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

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

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

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

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

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

[appendix]
== Reference material

=== Additional resources

// Get Involved
include::topics/get-involved.adoc[leveloffset=+3]
include::topics/mtr-get-involved.adoc[leveloffset=+3]

// Important Links
include::topics/important-links.adoc[leveloffset=+3]
include::topics/mtr-important-links.adoc[leveloffset=+3]

==== Reporting issues

Expand Down
4 changes: 2 additions & 2 deletions docs/intellij-idea-plugin-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ include::topics/making-open-source-more-inclusive.adoc[]
== Introduction

// About the IntelliJ IDEA plugin
include::topics/about-ide-addons.adoc[leveloffset=+2]
include::topics/mtr-about-ide-addons.adoc[leveloffset=+2]

// About {ProductName}
include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
include::topics/mtr-what-is-the-toolkit.adoc[leveloffset=+2]

// Install the plugin
include::topics/installing-intellij-idea-plugin.adoc[leveloffset=+1]
Expand Down
10 changes: 5 additions & 5 deletions docs/maven-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::topics/making-open-source-more-inclusive.adoc[]
include::topics/about-maven-guide.adoc[leveloffset=+2]

// About {ProductName}
include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
include::topics/mtr-what-is-the-toolkit.adoc[leveloffset=+2]

// About {MavenNameTitle}
include::topics/about-maven.adoc[leveloffset=+2]
Expand All @@ -36,7 +36,7 @@ include::topics/maven-multi-module.adoc[leveloffset=+2]
include::topics/maven-access-reports.adoc[leveloffset=+2]

// Export the Report in CSV Format
include::topics/csv-export.adoc[leveloffset=+1]
include::topics/mtr-csv-export.adoc[leveloffset=+1]

[appendix]
== Reference material
Expand All @@ -48,17 +48,17 @@ include::topics/maven-arguments.adoc[leveloffset=+2]
include::topics/maven-logging-properties.adoc[leveloffset=+2]

// Rule Story Points
include::topics/about-story-points.adoc[leveloffset=+2]
include::topics/mtr-about-story-points.adoc[leveloffset=+2]

For more information on categorizing tasks, see link:{ProductDocRulesGuideURL}/rule_categories_rules-development-guide#rule_categories_rules-development-guide[Using custom rule categories].

=== Additional resources

// Get Involved
include::topics/get-involved.adoc[leveloffset=+3]
include::topics/mtr-get-involved.adoc[leveloffset=+3]

// Important Links
include::topics/important-links.adoc[leveloffset=+3]
include::topics/mtr-important-links.adoc[leveloffset=+3]

// Report Issues with {ProductShortName}

Expand Down
4 changes: 2 additions & 2 deletions docs/plugin-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ include::topics/making-open-source-more-inclusive.adoc[]
include::topics/plugin-intro.adoc[leveloffset=+2]

// About {ProductName}
include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
include::topics/mtr-what-is-the-toolkit.adoc[leveloffset=+2]

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

// Install the IDE Plugin
include::topics/installing-plugin.adoc[leveloffset=+1]
Expand Down
4 changes: 2 additions & 2 deletions docs/rules-development-guide-mtr/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ include::topics/rule-categories.adoc[leveloffset=+1]
== Reference material

// Rule Story Points
include::topics/about-story-points.adoc[leveloffset=+2]
include::topics/mtr-about-story-points.adoc[leveloffset=+2]

For more information on categorizing tasks, see xref:rule-categories_{context}[Using custom rule categories].

Expand All @@ -100,7 +100,7 @@ include::topics/review-existing-rules.adoc[leveloffset=+3]
include::topics/fork-ruleset-repo.adoc[leveloffset=+4]

// Important Links
include::topics/rules-important-links.adoc[leveloffset=+3]
include::topics/mtr-rules-important-links.adoc[leveloffset=+3]

// **********************************
// * Appendix: Revision Information *
Expand Down
9 changes: 9 additions & 0 deletions docs/topics/mtr-about-cli-guide.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Module included in the following assemblies:
//
// * docs/cli-guide/master.adoc

:_content-type: CONCEPT
[id="about-cli-guide_{context}"]
= About the {UserCLIBookName}

This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications or other components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.
14 changes: 14 additions & 0 deletions docs/topics/mtr-about-cli.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Module included in the following assemblies:
//
// * docs/cli-guide/master.adoc
// * docs/getting-started-guide/master.adoc

:_content-type: CONCEPT
[id="about-cli_{context}"]
= About the {CLINameTitle}

The {CLIName} is a command-line tool in the {ProductName} that allows you to assess and prioritize migration and modernization efforts for applications. It provides numerous reports that highlight the analysis without the overhead of the other tools. The {CLIName} includes a wide array of customization options, and allows you to finely tune {ProductShortName} analysis options or integrate with external automation tools.

ifndef::cli-guide[]
For more information about using the {CLIName}, see the {ProductShortName} link:{ProductDocUserGuideURL}[_{UserCLIBookName}_].
endif::cli-guide[]
16 changes: 16 additions & 0 deletions docs/topics/mtr-about-ide-addons.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Module included in the following assemblies:
//
//
// * docs/getting-started-guide-guide/master.adoc

:_content-type: CONCEPT
[id="getting-started-about-ide-addons_{context}"]
= About the IDE Addons

You can migrate and modernize applications by using the {ProductName} ({ProductShortName}) addons for:

* Eclipse
* Visual Studio Code, Visual Studio Codespaces, and Eclipse Che
* IntelliJ IDEA, both the Community and Ultimate versions
Each addon 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.
9 changes: 9 additions & 0 deletions docs/topics/mtr-about-maven.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Module included in the following assemblies:
//
// * docs/maven-guide/master.adoc

:_content-type: CONCEPT
[id="about-maven_{context}"]
= About the {MavenNameTitle}

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.
26 changes: 26 additions & 0 deletions docs/topics/mtr-about-rules.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Module included in the following assemblies:
//
// * docs/rules-development-guide/master.adoc
// * docs/getting-started-guide/master.adoc

:_content-type: CONCEPT
[id="about-rules_{context}"]
= About {ProductShortName} rules

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.

{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.

{ProductShortName} rules use the following rule pattern:

----
when(condition)
perform(action)
otherwise(action)
----

{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.

ifndef::rules-development-guide[]
If you plan to write your own custom rules, see the {ProductDocRulesGuideURL}[_{RulesDevBookName}_] for detailed instructions.
endif::rules-development-guide[]
Loading

0 comments on commit f1cdd95

Please sign in to comment.