Skip to content

Merge post-GA 7.2.2 - MTA-4828: Removing discrete headers #124

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Merge post-GA 7.2.2 - MTA-4828: Removing discrete headers #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1fc098
MTA- : Removing discrete headers
anarnold97 Mar 14, 2025
62ccc68
update
anarnold97 Apr 2, 2025
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
4 changes: 1 addition & 3 deletions docs/topics/configuring-web-console-authentication-for-linux-windows-macos.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -86,7 +85,6 @@ C:\<MTR_HOME>\run_windup.bat
----
. Open the browser at `\http://localhost:8080/windup-ui`.

[discrete]
[id="disabling-authentication_{context}"]
== Disabling authentication

Expand Down
5 changes: 4 additions & 1 deletion docs/topics/csv-export.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -38,13 +39,15 @@ 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.
. Choose *File* -> *Open*.
. 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:
Expand Down
13 changes: 4 additions & 9 deletions docs/topics/execute.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -69,7 +68,6 @@ To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler`
$ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli -Dwindup.decompiler=procyon --input <INPUT_ARCHIVE_OR_DIRECTORY> --output <OUTPUT_REPORT_DIRECTORY> --target <TARGET_TECHNOLOGY> --packages <PACKAGE_1> <PACKAGE_2>
----

[discrete]
[id="cli-bash-completion_{context}"]
== About {ProductShortName} {CLINameTitle} Bash completion

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down
3 changes: 0 additions & 3 deletions docs/topics/mavenize.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions docs/topics/mta-cli-run-single-app.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ ./{mta-cli} analyze --input <path_to_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:
Expand All @@ -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.
Expand All @@ -56,7 +56,8 @@ $ <{ProductShortName}_HOME>/{mta-cli} analyze --mode source-only --input <path_t
--output <path_to_report_output> --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:
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/mta-what-is-the-toolkit.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
18 changes: 6 additions & 12 deletions docs/topics/testing-rules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,8 @@ In addition to the tags in the standard `perform action` syntax, the following `

* `<fail>`

[id="not-syntax_{context}"]
==== <not> syntax

[discrete]
===== Summary
[id="not-syntax-summary_{context}"]
==== Summary

The `<not>` element is the standard logical _not_ operator, and is commonly used to perform a `<fail>` if the condition is not met.

Expand Down Expand Up @@ -96,9 +93,6 @@ The `<not>` element has no unique attributes or child elements.
[id="iterable-filter-syntax_{context}"]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[id="iterable-filter-syntax_{context}"]

Copy link

@apurvabhide17 apurvabhide17 Apr 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this required? There is a similar id below - iterable-filter-syntax-summary?

==== <iterable-filter> syntax
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
==== <iterable-filter> syntax

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not applicable in the scope of this PR


[discrete]
===== Summary

The `<iterable-filter>` 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.
Expand Down Expand Up @@ -141,7 +135,7 @@ The following is an example that looks for four instances of the specified messa

The `<iterable-filter>` element has no unique child elements.

[discrete]
[id="iterable-filter-element_{context}"]
===== <iterable-filter> element attributes

[cols="1,1,3", options="header"]
Expand Down Expand Up @@ -204,7 +198,7 @@ The following is an example that searches for a specific classification title.

The `<classification-exists>` has no unique child elements.

[discrete]
[id="classification_exists_element_{context}"]
===== <classification-exists> element attributes

[cols="1,1,3", options="header"]
Expand Down Expand Up @@ -273,7 +267,7 @@ The following is an example that searches for a specific hint.

The `<hint-exists>` element has no unique child elements.

[discrete]
[id="hint-exists-element-attributes_{context}"]
===== <hint-exists> element attributes

[cols="1,1,3", options="header"]
Expand All @@ -298,7 +292,7 @@ The `<fail>` element reports the execution as a failure and displays the associa

The `<fail>` element has no unique child elements.

[discrete]
[id="fail-syntax-element-attributes_{context}"]
===== <fail> element attributes

[cols="1,1,3", options="header"]
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/web-openshift-environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions docs/topics/what-is-the-toolkit.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -33,15 +33,16 @@ 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.

{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}.
Expand Down