MTA-4775: Effort differs between applications depending on whether th…

docs/cli-guide/master.adoc

@@ -66,11 +66,11 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3]
 
 include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3]
 
+include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3]
+
 // Analyze application source code
 include::topics/mta-cli-analyze.adoc[leveloffset=+3]
 
-include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3]
-
 // Transform XML rules to YAML
 include::topics/mta-cli-transform.adoc[leveloffset=+3]
 
@@ -104,6 +104,9 @@ include::topics/mta-review-reports.adoc[leveloffset=+1]
 // Optimize {ProductShortName} Performance
 include::topics/mta-optimize-performance.adoc[leveloffset=+1]
 
+// Issues with reports
+include::topics/issues-with-report.adoc[leveloffset=+2]
+
 // Configure {ProductShortName} to Exclude Files and Packages
 // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2]
 

docs/topics/issues-with-report.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * docs/cli-guide/master.adoc
+
+:_content-type: CONCEPT
+[id="issues-with-report_{context}"]
+= Issues with reports
+
+Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by a number of factors;
+
+* The lack of a proper build file, for example, a `pom.xml` or `build.gradle` file
+* Compilation errors of one form or another
+
+.Running {ProductShortName} on a project with an inaccessible parent pom.xml file may not result in a full analysis
+
+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.
+
+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.
+
+This causes the jdtls to encounter a `Non-resolvable parent POM` 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.
+
+If you remove the parent pom.xml file and make the `kitchensink` project completely standalone, there are no issues.