From 4fe67bdb083c2a1304d310d9b50d6d5e02195269 Mon Sep 17 00:00:00 2001 From: Avital Pinnick Date: Wed, 1 Jul 2020 10:45:05 +0300 Subject: [PATCH] Fix procedure structure --- docs/topics_5/access-report.adoc | 22 +++++++++++++--------- docs/topics_5/add-rule-to-rhamt.adoc | 15 ++++++++------- docs/topics_5/all-csv-support.adoc | 6 ++---- docs/topics_5/cli-args.adoc | 12 ++++++++---- docs/topics_5/cli-prerequisites.adoc | 9 ++++++--- docs/topics_5/create-basic-xml-rule.adoc | 12 ++++++------ docs/topics_5/execute.adoc | 2 +- 7 files changed, 44 insertions(+), 34 deletions(-) diff --git a/docs/topics_5/access-report.adoc b/docs/topics_5/access-report.adoc index 97547f7bcc11..49faff4ff660 100644 --- a/docs/topics_5/access-report.adoc +++ b/docs/topics_5/access-report.adoc @@ -3,17 +3,10 @@ [id='access_report_{context}'] = Accessing Reports -When you execute {ProductName}, the report is generated in the `` that you specify using the `--output` argument in the command line. Upon completion of execution, you will see the following message in the terminal with the location of the report. - -[options="nowrap",subs="+quotes"] ----- -Report created: /index.html - Access it at this URL: file:////index.html ----- +When you run {ProductName}, a report is generated in the `` that you specify using the `--output` argument in the command line. The output directory contains the following files and subdirectories: -[options="nowrap",subs="+quotes"] ---- / ├── index.html // Landing page for the report @@ -24,4 +17,15 @@ The output directory contains the following files and subdirectories: ├── stats/ // Performance statistics ---- -Use a browser to open the `index.html` file located in the report output directory. +.Procedure + +. Obtain the path of the `index.html` file of your report from the output that appears after you run {ProductName}: ++ +---- +Report created: /index.html + Access it at this URL: file:////index.html +---- + +. Open the `index.html` file by using a browser. ++ +The generated report is displayed. diff --git a/docs/topics_5/add-rule-to-rhamt.adoc b/docs/topics_5/add-rule-to-rhamt.adoc index 3ffc82d798c9..f3a995476735 100644 --- a/docs/topics_5/add-rule-to-rhamt.adoc +++ b/docs/topics_5/add-rule-to-rhamt.adoc @@ -3,12 +3,13 @@ [id='add_the_rule_to_windup_{context}'] = Adding a Rule to {ProductName} -A {ProductName} rule is installed by copying the rule to the appropriate {ProductShortName} folder. {ProductShortName} scans for rules, which are files that end with `.windup.xml` or `.mta.xml`, in the following locations. +A {ProductName} rule is installed by copying the rule to the appropriate {ProductShortName} folder. {ProductShortName} scans for rules, which are files with the `.windup.xml` or `.mta.xml` extension in the following locations: -* The directory specified by the `--userRulesDirectory` argument on the {ProductShortName} command line. - -* The `/rules/` directory. `` is the directory where you install and run the {ProductName} executable. - -* The `${user.home}/.mta/rules/` directory. This directory is created by {ProductShortName} the first time it is executed and contains rules, add-ons, and the {ProductShortName} log. +* Directory specified by the `--userRulesDirectory` argument on the {ProductShortName} command line. +* `/rules/` directory. `` is the directory where you install and run the {ProductName} executable. +* `${user.home}/.mta/rules/` directory. This directory is created by {ProductShortName} the first time it is run. it contains rules, add-ons, and the {ProductShortName} log. + -NOTE: For Windows, this directory would be `\Documents and Settings\\.mta\rules\` or `\Users\\.mta\rules\`. +[NOTE] +==== +In a Windows operating system, the rules are located in `\Documents and Settings\\.mta\rules\` or `\Users\\.mta\rules\`. +==== diff --git a/docs/topics_5/all-csv-support.adoc b/docs/topics_5/all-csv-support.adoc index fdf4f43e218b..eb26b4141788 100644 --- a/docs/topics_5/all-csv-support.adoc +++ b/docs/topics_5/all-csv-support.adoc @@ -1,8 +1,6 @@ [id='all_csv_report_{context}'] = About the Inclusive CSV Report -When specifying the `--exportCSV` argument, an `AllIssues.csv` file is now -generated in the root directory of the report. +If you use the `--exportCSV` argument, an `AllIssues.csv` file is generated in the root directory of the report. -This file includes all discovered issues, spanning all analyzed applications, -in addition to the individual CSV files generated per application. +The `AllIssues.csv` file contains all discovered issues for all analyzed applications and individual CSV files for each application. diff --git a/docs/topics_5/cli-args.adoc b/docs/topics_5/cli-args.adoc index 4c51d9728423..7c96ad330730 100644 --- a/docs/topics_5/cli-args.adoc +++ b/docs/topics_5/cli-args.adoc @@ -7,9 +7,12 @@ The following is a detailed description of the available {ProductShortName} comm [NOTE] ==== -To run the {ProductShortName} command without prompting, for example when executing from a script, use `--batchMode` to take the default values for unspecified parameters and `--overwrite` to force delete the output directory. Also be sure to specify the required `--input` and `--target` arguments. +To run the {ProductShortName} command without prompting, for example when executing from a script, you must use the following arguments: -See the description for each argument for more details. +* `--batchMode` +* `--overwrite` +* `--input` +* `--target` ==== .{ProductShortName} CLI Arguments @@ -45,10 +48,11 @@ See the description for each argument for more details. |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. |--overwrite |Flag to force delete the existing output directory specified by `--output`. If you do not specify this argument and the `--output` directory exists, you are prompted to choose whether to overwrite the contents. -[WARNING] +[IMPORTANT] ==== -Be careful not to specify a report output directory that contains important information! +Do not overwrite a report output directory that contains important information. ==== + |--packages| A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument. |--remove |Remove the specified add-ons. The syntax is `:[:]`. For example, `--remove core-addon-x` or `--remove org.example.addon:example:1.0.0`. |--skipReports |Flag to indicate that HTML reports should not be generated. A common use of this argument is when exporting report data to a CSV file using `--exportCSV`. diff --git a/docs/topics_5/cli-prerequisites.adoc b/docs/topics_5/cli-prerequisites.adoc index 00c7dff8b75f..2c6fa52faf14 100644 --- a/docs/topics_5/cli-prerequisites.adoc +++ b/docs/topics_5/cli-prerequisites.adoc @@ -3,9 +3,12 @@ [id='cli_prerequisites_{context}'] = Prerequisites -Before installing the {CLIName}, verify that you meet the following prerequisites. +{CLIName} has the following prerequisites: * OpenJDK 1.8, OpenJDK 11, Oracle JDK 1.8, Oracle JDK 11 -* A minimum of 4 GB RAM; 8 GB recommended +* 8 GB RAM -NOTE: If you are running macOS, it is recommended to set the maximum number of user processes, `maxproc`, to at least `2048`, and the maximum number of open files, `maxfiles`, to `100000`. +{CLIName} on macOS has the following additional prerequisites: + +* `maxproc`: `2048` or greater +* `maxfiles`: `100000` diff --git a/docs/topics_5/create-basic-xml-rule.adoc b/docs/topics_5/create-basic-xml-rule.adoc index 45e3ca14a70a..5d1866ccaa38 100644 --- a/docs/topics_5/create-basic-xml-rule.adoc +++ b/docs/topics_5/create-basic-xml-rule.adoc @@ -7,7 +7,7 @@ This section describes how to create an {ProductShortName} XML rule. This assume == Creating a Basic XML Rule Template -{ProductShortName} XML rules consist of _conditions_ and _actions_ and use the following rule pattern. +{ProductShortName} XML rules consist of _conditions_ and _actions_ and use the following rule pattern: [source,options="nowrap"] ---- @@ -20,7 +20,7 @@ Create a file with the following contents, which is the basic syntax for XML rul [IMPORTANT] ==== -The {ProductShortName} XML rule file must use the `.windup.xml` or `.mta.xml` extension, otherwise the rule will not be evaluated. +The {ProductShortName} XML rule file must have the `.windup.xml` or `.mta.xml` extension. Otherwise, the rule will not be evaluated. ==== [source,xml] @@ -51,7 +51,7 @@ The {ProductShortName} XML rule file must use the `.windup.xml` or `.mta.xml` ex ---- -== Create the Ruleset Metadata +== Creating the Ruleset Metadata The XML ruleset `metadata` element provides additional information about the ruleset such as a description, the source and target technologies, and add-on dependencies. The metadata also allows for specification of tags, which allow you to provide additional information about a ruleset. @@ -86,14 +86,14 @@ The XML ruleset `metadata` element provides additional information about the rul ---- -== Create the Rule +== Creating a Rule Individual rules are contained within the `` element. They comprise one or more `when` conditions and perform actions. See the link:http://windup.jboss.org/schema/windup-jboss-ruleset.xsd[XML rule schema] for valid rule syntax. [id='create_when_condition_{context}'] -=== Create the Rule When Condition +=== Creating a `` Condition The XML rule `` element tests for a condition. The following is a list of valid `` conditions. @@ -140,7 +140,7 @@ The XML rule `` element tests for a condition. The following is a list of The specific syntax is dependent on whether you are creating a rule to evaluate Java class, an XML file, a project, or file content. [id='create_perform_action_{context}'] -=== Create the Rule Perform Action +=== Creating a Rule `` Action The XML rule `` element performs the action when the condition is met. Operations allowed in this section of the rule include the classification of application resources, in-line hints for migration steps, links to migration information, and project line item reporting. The following is a list of valid `` actions. diff --git a/docs/topics_5/execute.adoc b/docs/topics_5/execute.adoc index 91130b03ccc8..9148e9a2db3f 100644 --- a/docs/topics_5/execute.adoc +++ b/docs/topics_5/execute.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * docs/cli-guide_5/master.adoc [id='execute_{context}'] -= Runing the {CLINameTitle} += Running the {CLINameTitle} Use the following steps to run {ProductShortName} against your application.