diff --git a/docs/topics/configuring-web-console-authentication-for-linux-windows-macos.adoc b/docs/topics/configuring-web-console-authentication-for-linux-windows-macos.adoc index b12e120f..4fac3ed2 100644 --- a/docs/topics/configuring-web-console-authentication-for-linux-windows-macos.adoc +++ b/docs/topics/configuring-web-console-authentication-for-linux-windows-macos.adoc @@ -8,8 +8,7 @@ You can configure the {WebName} to require authentication for access. To enable authentication, you have to install Red Hat Single Sign-On (SSO). -[discrete] -[id="enabling-authentication_{context}"] +[id="mta-enabling-authentication_{context}"] == Enabling authentication .Procedure @@ -86,7 +85,6 @@ C:\\run_windup.bat ---- . Open the browser at `\http://localhost:8080/windup-ui`. -[discrete] [id="disabling-authentication_{context}"] == Disabling authentication diff --git a/docs/topics/csv-export.adoc b/docs/topics/csv-export.adoc index f73eac30..a403eed1 100644 --- a/docs/topics/csv-export.adoc +++ b/docs/topics/csv-export.adoc @@ -29,7 +29,8 @@ The CSV files are exported to the directory specified by the `outputDirectory` a endif::maven-guide[] ifdef::cli-guide[] -[discrete] + +[id="access-report-from-app-report_{context}"] === Accessing the report from the application report If you have exported the CSV report, you can download all of the CSV issues in the Issues Report. To download these issues, click *Download All Issues CSV* in the Issues Report. @@ -38,6 +39,7 @@ If you have exported the CSV report, you can download all of the CSV issues in t image::4-1-issues-report-with-csv-download.png[Issues report with CSV download] endif::cli-guide[] +[id="import-csv-file-spreadsheet_{context}"] == Importing the CSV file into a spreadsheet program . Launch the spreadsheet software, for example, Microsoft Excel. @@ -45,6 +47,7 @@ endif::cli-guide[] . Browse to the CSV exported file and select it. . The data is now ready to analyze in the spreadsheet software. +[id="about-csv-data-strcture_{context}"] == About the CSV data structure The CSV formatted output file contains the following data fields: diff --git a/docs/topics/execute.adoc b/docs/topics/execute.adoc index a9be7243..7bfe6608 100644 --- a/docs/topics/execute.adoc +++ b/docs/topics/execute.adoc @@ -25,11 +25,10 @@ $ ./{LC_PSN}-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/ou . Access the report. -[discrete] [id="command-examples_{context}"] == {ProductShortName} Command examples -[discrete] +[id="running-mta-application-archive_{context}"] === Running {ProductShortName} on an application archive The following command analyzes the `com.acme` and `org.apache` packages of the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating from JBoss EAP 5 to JBoss EAP 7: @@ -39,7 +38,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l $ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/report-output/ --source eap:5 --target eap:7 --packages com.acme org.apache ---- -[discrete] +[id="running-mta-on-source-code_{context}"] === Running {ProductShortName} on source code The following command analyzes the `org.jboss.seam` packages of the link:https://github.com/windup/windup/tree/master/test-files/seam-booking-5.2[seam-booking-5.2] example source code for migrating to JBoss EAP 6. @@ -49,7 +48,7 @@ The following command analyzes the `org.jboss.seam` packages of the link:https:/ $ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli --sourceMode --input /path/to/seam-booking-5.2/ --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam ---- -[discrete] +[id="running-mta-cloud-readiness-rules_{context}"] === Running cloud-readiness rules The following command analyzes the `com.acme` and `org.apache` packages of the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating to JBoss EAP 7. It also evaluates for cloud readiness: @@ -59,7 +58,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l $ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/report-output/ --target eap:7 --target cloud-readiness --packages com.acme org.apache ---- -[discrete] +[id="overriding-mta-product-properties_{context}"] === Overriding {ProductShortName} properties To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler` argument on the command line. For example, to use the _Procyon_ decompiler, use the following syntax: @@ -69,7 +68,6 @@ To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler` $ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli -Dwindup.decompiler=procyon --input --output --target --packages ---- -[discrete] [id="cli-bash-completion_{context}"] == About {ProductShortName} {CLINameTitle} Bash completion @@ -80,7 +78,6 @@ The {ProductShortName} {CLIName} provides an option to enable Bash completion fo $ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli [TAB] ---- -[discrete] [id="bash-completion-temporary_{context}"] === Enabling Bash completion @@ -91,7 +88,6 @@ To enable Bash completion for the current shell, execute the following command: $ source <{ProductShortName}_HOME>/bash-completion/{LC_PSN}-cli ---- -[discrete] [id="bash-completion-persistent_{context}"] === Enabling persistent Bash completion @@ -111,7 +107,6 @@ source <{ProductShortName}_HOME>/bash-completion/{LC_PSN}-cli # cp <{ProductShortName}_HOME>/bash-completion/{LC_PSN}-cli /etc/bash_completion.d/ ---- -[discrete] [id="accessing-help_{context}"] == Accessing {ProductShortName} help diff --git a/docs/topics/mavenize.adoc b/docs/topics/mavenize.adoc index d0f01ba4..7ac8fc62 100644 --- a/docs/topics/mavenize.adoc +++ b/docs/topics/mavenize.adoc @@ -51,7 +51,6 @@ The example `jee-example-app-1.0.0.ear` application is an EAR archive that conta Review each of the generated files and customize as appropriate for your project. To learn more about Maven POM files, see the link:https://maven.apache.org/guides/introduction/introduction-to-the-pom.html[Introduction to the POM] section of the Apache Maven documentation. [id="root-pom-file_{context}"] -[discrete] === Root POM file The root POM file for the `jee-example-app-1.0.0.ear` application can be found at `/path/to/output/mavenized/jee-example-app/pom.xml`. This file identifies the directories for all of the project modules. @@ -76,7 +75,6 @@ The root POM is also configured to use the link:https://maven.repository.redhat. [id="bom-file_{context}"] -[discrete] === BOM file The Bill of Materials (BOM) file is generated in the directory ending in `-bom`. For the example `jee-example-app-1.0.0.ear` application, the BOM file can be found at `/path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml`. The purpose of this BOM is to have the versions of third-party dependencies used by the project defined in one place. For more information on using a BOM, see the link:https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html[Introduction to the dependency mechanism] section of the Apache Maven documentation. @@ -102,7 +100,6 @@ The following dependencies are listed in the BOM for the example `jee-example-ap ---- [id="app-pom-files_{context}"] -[discrete] === Application POM files Each application module that can be mavenized has a separate directory containing its POM file. The directory name contains the name of the archive and ends in a `-jar`, `-war`, or `-ear` suffix, depending on the archive type. diff --git a/docs/topics/mta-cli-run-single-app.adoc b/docs/topics/mta-cli-run-single-app.adoc index b9dcd604..2f194d7e 100644 --- a/docs/topics/mta-cli-run-single-app.adoc +++ b/docs/topics/mta-cli-run-single-app.adoc @@ -31,7 +31,7 @@ $ ./{mta-cli} analyze --input \ [id="command-examples_{context}"] == {ProductShortName} command examples -[discrete] +[id="running-mta-cli-single-app-archive_{context}"] === Running {ProductShortName} on an application archive The following command analyzes the example EAR archive named `jee-example-app-1.0.0.ear` for migrating from JBoss EAP 5 to JBoss EAP 7: @@ -44,7 +44,7 @@ $ <{ProductShortName}_HOME>/{mta-cli} analyze \ ---- [] -[discrete] +[id="running-mta-cli-single-source-code_{context}"] === Running {ProductShortName} on source code The following command analyzes the source code of an example application called `customer-management` for migrating to JBoss EAP 8. @@ -56,7 +56,8 @@ $ <{ProductShortName}_HOME>/{mta-cli} analyze --mode source-only --input --target eap8 ---- [] -[discrete] + +[id="running-mta-cli-single-cloud-readiness_{context}"] === Running cloud-readiness rules The following command analyzes the example EAR archive named `jee-example-app-1.0.0.ear` for migrating to JBoss EAP 7. It also evaluates the archive for cloud readiness: diff --git a/docs/topics/mta-what-is-the-toolkit.adoc b/docs/topics/mta-what-is-the-toolkit.adoc index 30901210..84737872 100644 --- a/docs/topics/mta-what-is-the-toolkit.adoc +++ b/docs/topics/mta-what-is-the-toolkit.adoc @@ -12,7 +12,7 @@ [id="mta-what-is-the-toolkit_{context}"] = About the {ProductName} -[discrete] +[id="what-is-mta_{context}"] == What is the {ProductName}? {ProductName} ({ProductShortName}) accelerates large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to OpenShift via the user interface. @@ -26,7 +26,7 @@ In {ProductShortName} 7.1 and later, when you add an application to the *Applica {ProductShortName} examines application artifacts, including project source directories and application archives, and then produces an HTML report highlighting areas needing changes. -[discrete] +[id="how-mta-app-simplify-migration_{context}"] == How does the {ProductName} simplify migration? The {ProductName} looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application. diff --git a/docs/topics/testing-rules.adoc b/docs/topics/testing-rules.adoc index 672c184b..f4f1572a 100644 --- a/docs/topics/testing-rules.adoc +++ b/docs/topics/testing-rules.adoc @@ -45,11 +45,8 @@ In addition to the tags in the standard `perform action` syntax, the following ` * `` -[id="not-syntax_{context}"] -==== syntax - -[discrete] -===== Summary +[id="not-syntax-summary_{context}"] +==== Summary The `` element is the standard logical _not_ operator, and is commonly used to perform a `` if the condition is not met. @@ -96,9 +93,6 @@ The `` element has no unique attributes or child elements. [id="iterable-filter-syntax_{context}"] ==== syntax -[discrete] -===== Summary - The `` element counts the number of times a condition is verified. For additional information, see the link:{LinkAPI}rules-base/api/src/main/java/org/jboss/windup/rules/general/IterableFilter.java[IterableFilter] class. The following is an example that looks for four instances of the specified message. @@ -141,7 +135,7 @@ The following is an example that looks for four instances of the specified messa The `` element has no unique child elements. -[discrete] +[id="iterable-filter-element_{context}"] ===== element attributes [cols="1,1,3", options="header"] @@ -204,7 +198,7 @@ The following is an example that searches for a specific classification title. The `` has no unique child elements. -[discrete] +[id="classification_exists_element_{context}"] ===== element attributes [cols="1,1,3", options="header"] @@ -273,7 +267,7 @@ The following is an example that searches for a specific hint. The `` element has no unique child elements. -[discrete] +[id="hint-exists-element-attributes_{context}"] ===== element attributes [cols="1,1,3", options="header"] @@ -298,7 +292,7 @@ The `` element reports the execution as a failure and displays the associa The `` element has no unique child elements. -[discrete] +[id="fail-syntax-element-attributes_{context}"] ===== element attributes [cols="1,1,3", options="header"] diff --git a/docs/topics/web-openshift-environment.adoc b/docs/topics/web-openshift-environment.adoc index ddbeaa7c..aa0f9256 100644 --- a/docs/topics/web-openshift-environment.adoc +++ b/docs/topics/web-openshift-environment.adoc @@ -26,7 +26,7 @@ image::webconsole-architecture-empty-dir.png[web-template-empty-dir-executor.jso .`web-template-empty-dir-executor-shared-storage.json` image::webconsole-architecture-shared-storage.png[web-template-empty-dir-executor-shared-storage.json] -[discrete] +[id="openshift-template-env-variables_{context}"] == OpenShift template environment variables The OpenShift image environment variables are configured as a baseline for application analysis, and work well in a variety of environments. No additional configuration is required to perform an analysis. diff --git a/docs/topics/what-is-the-toolkit.adoc b/docs/topics/what-is-the-toolkit.adoc index b79d325a..2c7217a6 100644 --- a/docs/topics/what-is-the-toolkit.adoc +++ b/docs/topics/what-is-the-toolkit.adoc @@ -13,7 +13,7 @@ [id="what-is-the-toolkit_{context}"] = About the {ProductName} -[discrete] +[id="what-is-the-mta_{context}"] == What is the {ProductName}? The {ProductName} ({ProductShortName}) is an extensible and customizable rule-based tool that simplifies the migration and modernization of Java applications. @@ -33,7 +33,7 @@ The {ProductName} ({ProductShortName}) is an extensible and customizable rule-ba For more information about use cases and migration paths, see the link:https://developers.redhat.com/products/{LC_PSN}/use-cases[{ProductShortName} for developers] web page. -[discrete] +[id="mta-simplify-migration_{context}"] == How does the {ProductName} simplify migration? The {ProductName} looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application. @@ -41,7 +41,8 @@ The {ProductName} looks for common resources and known trouble spots when migrat {ProductShortName} generates a detailed report evaluating a migration or modernization path. This report can help you to estimate the effort required for large-scale projects and to reduce the work involved. ifndef::getting-started-guide[] -[discrete] + +[id="how-to-learn-more_{context}"] == How do I learn more? See the link:{ProductDocIntroToMTAGuideURL}[Introduction to the {DocInfoProductName}] to learn more about the features, supported configurations, system requirements, and available tools in the {ProductName}.