Skip to content

MTA-4985: Update application report documentation #153

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.

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 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions docs/topics/access-report.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ The output directory contains the following files and subdirectories:

----
<OUTPUT_REPORT_DIRECTORY>/
├── index.html // Landing page for the report
├── <EXPORT_FILE>.csv // Optional export of data in CSV format
├── archives/ // Archives extracted from the application
├── mavenized/ // Optional Maven project structure
├── reports/ // Generated HTML reports
── stats/ // Performance statistics
├── analysis.log
├── dependencies.yaml // Dependencies analysis output
├── output.yaml // Analysis output
├── shim.log // `windup-shim` log (the technology that translates XML into YAML rules.
├── static-report // Folder that contains the static files of the report. The report is viewed by opening the `index.html` file that this folder contains.
── static-report.log
----

.Procedure
Expand Down
Binary file modified docs/topics/images/3-3-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/topics/images/3-4-issues-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/topics/images/3-5-expanded-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/topics/images/3-8-technologies-in-application.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 1 addition & 38 deletions docs/topics/mta-review-reports.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ NOTE: The incidents and estimated story points change as new rules are added to

The following table lists all of the reports and pages that can be accessed from this main {ProductShortName} landing page. Click the name of the application, *jee-example-app-1.0.0.ear*, to view the application report.

// please can I ask for a QE validation
[cols="30%,70%", options="header"]
|====
| Page
Expand Down Expand Up @@ -77,44 +78,6 @@ The top navigation bar lists the various reports that contain additional details

| Dependencies
| Displays all Java-packaged dependencies found within the application.

| Unparsable
| Shows all files that {ProductShortName} could not parse in the expected format. For instance, a file with a `.xml` or `.wsdl` suffix is assumed to be an XML file. If the XML parser fails, the issue is reported here and also where the individual file is listed.

| Remote services
| Displays all remote services references that were found within the application.

| EJBs
| Contains a list of EJBs found within the application.

| JBPM
| Contains all of the JBPM-related resources that were discovered during analysis.

| JPA
| Contains details on all JPA-related resources that were found in the application.

| Hibernate
| Contains details on all Hibernate-related resources that were found in the application.

| Server resources
| Displays all server resources (for example, JNDI resources) in the input application.

| Spring Beans
| Contains a list of Spring Beans found during the analysis.

| Hard-coded IP addresses
| Provides a list of all hard-coded IP addresses that were found in the application.

| Ignored files
ifdef::cli-guide[]
| Lists the files found in the application that, based on certain rules and {ProductShortName} configuration, were not processed. See the `--userIgnorePath` option for more information.
endif::[]
ifdef::maven-guide[]
| Lists the files found in the application that, based on certain rules and {ProductShortName} configuration, were not processed. See the `userIgnorePath` option for more information.
endif::[]

| About
| Describes the current version of {ProductShortName} and provides helpful links for further assistance.
|====

[id="issues-report_{context}"]
Expand Down