Skip to content

Commit 83396cc

Browse files
committed
MTA- : Removing discrete headers
Signed-off-by: A.Arnold <[email protected]>
1 parent dd484d7 commit 83396cc

14 files changed

+48
-301
lines changed

docs/cli-guide/master.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3]
6666

6767
include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3]
6868

69+
include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3]
70+
6971
// Analyze application source code
7072
include::topics/mta-cli-analyze.adoc[leveloffset=+3]
7173

72-
include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3]
73-
7474
// Transform XML rules to YAML
7575
include::topics/mta-cli-transform.adoc[leveloffset=+3]
7676

@@ -104,6 +104,9 @@ include::topics/mta-review-reports.adoc[leveloffset=+1]
104104
// Optimize {ProductShortName} Performance
105105
include::topics/mta-optimize-performance.adoc[leveloffset=+1]
106106

107+
// Issues with reports
108+
include::topics/issues-with-report.adoc[leveloffset=+2]
109+
107110
// Configure {ProductShortName} to Exclude Files and Packages
108111
// include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2]
109112

docs/topics/cli-run.adoc

Lines changed: 0 additions & 143 deletions
This file was deleted.

docs/topics/configuring-web-console-authentication-for-linux-windows-macos.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99
You can configure the {WebName} to require authentication for access. To enable authentication, you have to install Red Hat Single Sign-On (SSO).
1010

11-
[discrete]
12-
[id="enabling-authentication_{context}"]
11+
[id="mta-enabling-authentication_{context}"]
1312
== Enabling authentication
1413

1514
.Procedure
@@ -86,7 +85,6 @@ C:\<MTR_HOME>\run_windup.bat
8685
----
8786
. Open the browser at `\http://localhost:8080/windup-ui`.
8887

89-
[discrete]
9088
[id="disabling-authentication_{context}"]
9189
== Disabling authentication
9290

docs/topics/csv-export.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ The CSV files are exported to the directory specified by the `outputDirectory` a
2929
endif::maven-guide[]
3030

3131
ifdef::cli-guide[]
32-
[discrete]
32+
33+
[id="access-report-from-app-report_{context}"]
3334
=== Accessing the report from the application report
3435

3536
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,13 +39,15 @@ If you have exported the CSV report, you can download all of the CSV issues in t
3839
image::4-1-issues-report-with-csv-download.png[Issues report with CSV download]
3940
endif::cli-guide[]
4041

42+
[id="import-csv-file-spreadsheet_{context}"]
4143
== Importing the CSV file into a spreadsheet program
4244

4345
. Launch the spreadsheet software, for example, Microsoft Excel.
4446
. Choose *File* -> *Open*.
4547
. Browse to the CSV exported file and select it.
4648
. The data is now ready to analyze in the spreadsheet software.
4749

50+
[id="about-csv-data-strcture_{context}"]
4851
== About the CSV data structure
4952

5053
The CSV formatted output file contains the following data fields:

docs/topics/execute.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,10 @@ $ ./{LC_PSN}-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/ou
2525

2626
. Access the report.
2727

28-
[discrete]
2928
[id="command-examples_{context}"]
3029
== {ProductShortName} Command examples
3130

32-
[discrete]
31+
[id="running-mta-application-archive_{context}"]
3332
=== Running {ProductShortName} on an application archive
3433

3534
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
3938
$ <{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
4039
----
4140

42-
[discrete]
41+
[id="running-mta-on-source-code_{context}"]
4342
=== Running {ProductShortName} on source code
4443

4544
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:/
4948
$ <{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
5049
----
5150

52-
[discrete]
51+
[id="running-mta-cloud-readiness-rules_{context}"]
5352
=== Running cloud-readiness rules
5453

5554
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
5958
$ <{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
6059
----
6160

62-
[discrete]
61+
[id="overriding-mta-product-properties_{context}"]
6362
=== Overriding {ProductShortName} properties
6463

6564
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`
6968
$ <{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>
7069
----
7170

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

@@ -80,7 +78,6 @@ The {ProductShortName} {CLIName} provides an option to enable Bash completion fo
8078
$ <{ProductShortName}_HOME>/bin/{LC_PSN}-cli [TAB]
8179
----
8280

83-
[discrete]
8481
[id="bash-completion-temporary_{context}"]
8582
=== Enabling Bash completion
8683

@@ -91,7 +88,6 @@ To enable Bash completion for the current shell, execute the following command:
9188
$ source <{ProductShortName}_HOME>/bash-completion/{LC_PSN}-cli
9289
----
9390

94-
[discrete]
9591
[id="bash-completion-persistent_{context}"]
9692
=== Enabling persistent Bash completion
9793

@@ -111,7 +107,6 @@ source <{ProductShortName}_HOME>/bash-completion/{LC_PSN}-cli
111107
# cp <{ProductShortName}_HOME>/bash-completion/{LC_PSN}-cli /etc/bash_completion.d/
112108
----
113109

114-
[discrete]
115110
[id="accessing-help_{context}"]
116111
== Accessing {ProductShortName} help
117112

docs/topics/issues-with-report.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/cli-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="issues-with-report_{context}"]
7+
= Issues with reports
8+
9+
.Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis
10+
11+
Running {ProductFullName} on a project with an inaccessible parent pom.xml file may not result in a full analysis. For example, this issue impacts the link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA[JBoss EAP Quickstarts], which demonstrate JBoss EAP, Jakarta EE 10, and other additional technologies. They provide small, specific, working examples that can be used as a reference for your project. However, these quickstarts specify a relative path to their parent POM file, which does not exist when the {ProductShortName} container is run.
12+
13+
Specifying an input path of link:https://github.com/jboss-developer/jboss-eap-quickstarts/tree/EAP_7.4.0.GA/kitchensink[`kitchensink`] mounts the `kitchensink` directory as a volume in the container, but that means that the JDT Language Server (jdtls) is unable to access the parent link:https://github.com/jboss-developer/jboss-eap-quickstarts/blob/EAP_7.4.0.GA/kitchensink/pom.xml[pom.xml] file.
14+
15+
This causes the jdtls to encounter a `Non-resolvable parent POM for org.jboss.eap.quickstarts:kitchensink:7.4.0.GA error` project build error. This error creates a `.project` file, which is missing the `org.eclipse.jdt.core.javanature`, meaning that jdtls, and subsequently {ProductShortName}, is unable to access details about the Java files.
16+
17+
If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues.

docs/topics/mavenize.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ The example `jee-example-app-1.0.0.ear` application is an EAR archive that conta
5151
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.
5252

5353
[id="root-pom-file_{context}"]
54-
[discrete]
5554
=== Root POM file
5655

5756
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.
7675

7776

7877
[id="bom-file_{context}"]
79-
[discrete]
8078
=== BOM file
8179

8280
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
102100
----
103101

104102
[id="app-pom-files_{context}"]
105-
[discrete]
106103
=== Application POM files
107104

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

docs/topics/mta-cli-run-single-app.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ $ ./{mta-cli} analyze --input <path_to_input> \
3131
[id="command-examples_{context}"]
3232
== {ProductShortName} command examples
3333

34-
[discrete]
34+
[id="running-mta-cli-single-app-archive_{context}"]
3535
=== Running {ProductShortName} on an application archive
3636

3737
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 \
4444
----
4545
[]
4646

47-
[discrete]
47+
[id="running-mta-cli-single-source-code_{context}"]
4848
=== Running {ProductShortName} on source code
4949

5050
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 <path_t
5656
--output <path_to_report_output> --target eap8
5757
----
5858
[]
59-
[discrete]
59+
60+
[id="running-mta-cli-single-cloud-readiness_{context}"]
6061
=== Running cloud-readiness rules
6162

6263
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:

0 commit comments

Comments
 (0)