Skip to content
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

MTA-2257: (MTR) Diverging MTA and MTR documentation #853

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

MTA-2257: (MTR) Diverging MTA and MTR documentation #853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 17 additions & 17 deletions docs/cli-guide-mtr/master.adoc
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
12 changes: 6 additions & 6 deletions docs/intellij-idea-plugin-guide-mtr/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,28 @@ 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]
include::topics/mtr-installing-intellij-idea-plugin.adoc[leveloffset=+1]

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

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

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

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

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

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

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

:!idea-plugin:
24 changes: 12 additions & 12 deletions docs/maven-guide-mtr/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,49 +16,49 @@ include::topics/making-open-source-more-inclusive.adoc[]
== Introduction

// About the {MavenBookName}
include::topics/about-maven-guide.adoc[leveloffset=+2]
include::topics/mtr-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]
include::topics/mtr-about-maven.adoc[leveloffset=+2]

== Getting started

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

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

// Access the Report
include::topics/maven-access-reports.adoc[leveloffset=+2]
include::topics/mtr-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

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

// Default `logging.properties` in {MavenShortName}
include::topics/maven-logging-properties.adoc[leveloffset=+2]
include::topics/mtr-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
Loading