Skip to content

Commit 25535ae

Browse files
anarnold97anarnold97
committed
MTA-2257: Diverging MTA and MTR documentation
Signed-off-by: Andy Arnold <[email protected]>
1 parent 8e246ee commit 25535ae

File tree

106 files changed

+5347
-200
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+5347
-200
lines changed

‎docs/cli-guide-mtr/master.adoc

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

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

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

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

2828
== Installing and Running the CLI
2929

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

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

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

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

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

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

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

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

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

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

6060
[appendix]
6161
== Reference material
6262

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

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

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

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

7474
=== Additional Resources
7575

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

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

8282
// Report Issues with {ProductShortName}
8383

‎docs/eclipse-code-ready-studio-guide-mtr/master.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,29 @@ include::topics/making-open-source-more-inclusive.adoc[]
2121
[id="introduction_{context}"]
2222
== Introduction
2323

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

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

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

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

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

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

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

4141
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}.
4242

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

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

5656
You can create and import custom rulesets.
5757

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

6363
:!eclipse-code-ready-studio-guide:

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

Lines changed: 20 additions & 20 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
23-
include::topics/what-is-the-toolkit.adoc[leveloffset=+1]
23+
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,56 +40,56 @@ 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}
46-
include::topics/about-cli.adoc[leveloffset=+2]
46+
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
8585

8686
=== Additional resources
8787

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

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

9494
==== Reporting issues
9595

‎docs/intellij-idea-plugin-guide-mtr/master.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,28 +20,28 @@ include::topics/making-open-source-more-inclusive.adoc[]
2020
== Introduction
2121

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

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

2828
// Install the plugin
29-
include::topics/installing-intellij-idea-plugin.adoc[leveloffset=+1]
29+
include::topics/mtr-installing-intellij-idea-plugin.adoc[leveloffset=+1]
3030

3131
[id="analyzing-projects-with-idea-plugin"]
3232
== Analyzing your projects with the {ProductShortName} plugin
3333

3434
You can analyze your projects with the {ProductShortName} plugin by creating a run configuration and running an analysis.
3535

36-
include::topics/intellij-idea-plugin-run-configuration.adoc[leveloffset=+2]
36+
include::topics/mtr-intellij-idea-plugin-run-configuration.adoc[leveloffset=+2]
3737

3838
[id="reviewing-and-resolving-migration-issues"]
3939
== Reviewing and resolving migration issues
4040

4141
You can review and resolve migration issues identified by the {ProductShortName} plugin in the left pane.
4242

43-
include::topics/intellij-idea-plugin-reviewing-issues.adoc[leveloffset=+2]
43+
include::topics/mtr-intellij-idea-plugin-reviewing-issues.adoc[leveloffset=+2]
4444

45-
include::topics/intellij-idea-plugin-resolving-issues.adoc[leveloffset=+2]
45+
include::topics/mtr-intellij-idea-plugin-resolving-issues.adoc[leveloffset=+2]
4646

4747
:!idea-plugin:

‎docs/maven-guide-mtr/master.adoc

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

1818
// About the {MavenBookName}
19-
include::topics/about-maven-guide.adoc[leveloffset=+2]
19+
include::topics/mtr-about-maven-guide.adoc[leveloffset=+2]
2020

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

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

2727
== Getting started
2828

2929
// Run the {MavenNameTitle}
30-
include::topics/maven-run.adoc[leveloffset=+2]
30+
include::topics/mtr-maven-run.adoc[leveloffset=+2]
3131

3232
// Run the {MavenNameTitle} with Multiple Modules
33-
include::topics/maven-multi-module.adoc[leveloffset=+2]
33+
include::topics/mtr-maven-multi-module.adoc[leveloffset=+2]
3434

3535
// Access the Report
36-
include::topics/maven-access-reports.adoc[leveloffset=+2]
36+
include::topics/mtr-maven-access-reports.adoc[leveloffset=+2]
3737

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

4141
[appendix]
4242
== Reference material
4343

4444
// {MavenNameTitle} Arguments
45-
include::topics/maven-arguments.adoc[leveloffset=+2]
45+
include::topics/mtr-maven-arguments.adoc[leveloffset=+2]
4646

4747
// Default `logging.properties` in {MavenShortName}
48-
include::topics/maven-logging-properties.adoc[leveloffset=+2]
48+
include::topics/mtr-maven-logging-properties.adoc[leveloffset=+2]
4949

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

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

5555
=== Additional resources
5656

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

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

6363
// Report Issues with {ProductShortName}
6464

0 commit comments

Comments
 (0)