windup · sgilda · Dec 23, 2014 · Dec 23, 2014
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
@@ -122,14 +122,14 @@ git checkout -b gh-pages windup
 
 +
 ----
-mkdir -p docs/2.0.0.Beta6/html
+mkdir -p docs/2.0.0.VERSION/html
 ----
 
 * Copy any new images, stylesheets, and html files from windup-documentation:
 
 +
 ----
-cp ../windup-documentation/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.Beta6/html/
+cp ../windup-documentation/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.VERSION/html/
 ----
 
 * Add the updated files to GitHub.
@@ -153,5 +153,5 @@ git commit -m "HTML docs"
 git push upstream gh-pages
 ----
 
-* View the documentation at <http://windup.github.io/windup/docs/2.0.0.Beta6/html/>
+* View the documentation at <http://windup.github.io/windup/docs/2.0.0.VERSION/html/>
 
diff --git a/README.adoc b/README.adoc
@@ -45,13 +45,13 @@ git checkout -b gh-pages windup
 * If the directory does not yet exist, create a docs/WINDUP-RELEASE-html/ directory.
 +
 ----
-mkdir -p docs/2.0.0.Beta6/html (if it doesn't exist!)
+mkdir -p docs/2.0.0.VERSION/html (if it doesn't exist!)
 ----
 
 * Copy any new images, stylesheets, and html files from windup-documentation:
 +
 ----
-cp ../windup-documentation/html/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.Beta6/html
+cp ../windup-documentation/html/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.VERSION/html
 ----
 
 * Add the updated files to GitHub.
@@ -79,9 +79,9 @@ View the documentation at the following URLs.
 [cols="2*"]
 |===
 | **Guide** | **URL**
-| Windup User Guide | http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupUserGuide.html
-| Windup Rules Development Guide | http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupRulesDevelopmentGuide.html
-| Windup Core Development Guide | http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupCoreDevelopmentGuide.html
+| Windup User Guide | http://windup.github.io/windup/docs/2.0.0.Beta7/html/WindupUserGuide.html
+| Windup Rules Development Guide | http://windup.github.io/windup/docs/2.0.0.Beta7/html/WindupRulesDevelopmentGuide.html
+| Windup Core Development Guide | http://windup.github.io/windup/docs/2.0.0.Beta7/html/WindupCoreDevelopmentGuide.html
 | Windup Migration Planning Guide | TBD
 |===
 

diff --git a/docs/About-the-WINDUP_HOME-Variable.adoc b/docs/About-the-WINDUP_HOME-Variable.adoc
@@ -4,4 +4,4 @@
 This documentation uses the `WINDUP_HOME` *replaceable* value to denote the path to the Windup distribution. When you encounter this value in the documentation, be sure to replace it with the actual path to your Windup installation.
 
 * If you download and install the latest distribution of Windup from the JBoss Nexus repository, `WINDUP_HOME` refers to the `windup-distribution-2.0.0.VERSION` folder extracted from the downloaded ZIP file.
-* If you build Windup from GitHub source, `WINDUP_HOME` refers to the `windup-distribution-2.0.0-<version>` folder extracted from the Windup source `dist/target/windup-distribution-2.0.0-VERSION.zip` file.
+* If you build Windup from GitHub source, `WINDUP_HOME` refers to the `windup-distribution-2.0.0-VERSION` folder extracted from the Windup source `dist/target/windup-distribution-2.0.0-VERSION.zip` file.
diff --git a/docs/Dev-Build-Windup-from-Source.adoc b/docs/Dev-Build-Windup-from-Source.adoc
@@ -2,7 +2,9 @@
 === Build Windup from Source
 
 This information is provided for new developers who plan to contribute code
-to the Windup open source project. If you use Linux and are an experienced Windup developer looking for a quick refresher, jump to: xref:quick-build-review-for-experienced-windup-developers[Quick Build Review for Experienced Windup Developers].
+to the Windup open source project. This section describes how to build Windup from source and how to extract the Windup distribution that is created during the build process.
+
+If you use Linux and are an experienced Windup developer looking for a quick refresher, jump to: xref:quick-build-review-for-experienced-windup-developers[Quick Build Review for Experienced Windup Developers].
 
 ==== System Requirements to Build Windup
 
@@ -88,6 +90,8 @@ mvn clean install -DskipTests
 
 ==== Build Windup Using Red Hat JBoss Developer Studio or Eclipse
 
+If you prefer, you can use an IDE to build Windup.
+
 . Make sure you have configured the Maven installation in your IDE as
 described here:
 https://github.com/windup/windup/wiki/Install-and-Configure-Maven[Install
@@ -104,6 +108,13 @@ _Incomplete Maven Goal Execution_, ignore it and click `OK` to continue.
 . In the Project Explorer tab, find the `windup_parent` project in the
 list, right-mouse, and choose `Run As` --> `Maven install`.
 
+==== Extract the Windup Distribution Source File
+
+The build process creates a `windup-distribution-2.0.0-SNAPSHOT-offline.zip file` in the Windup source `dist/target/` directory. 
+
+Unzip the `dist/target/windup-distribution-2.0.0-SNAPSHOT-offline.zip` file into a directory of your choice.
+
+
 [[quick-build-review-for-experienced-windup-developers]]
 ==== Quick Build Review for Experienced Windup Developers
 

diff --git a/docs/Dev-Execute-Windup-Built-from-Source.adoc b/docs/Dev-Execute-Windup-Built-from-Source.adoc
@@ -1,117 +1,12 @@
 [[Dev-Execute-Windup-Built-from-Source]]
 === Execute Windup (Built from Windup Source)
 
-_These instructions are for Windup core developers who are new to the project and unfamiliar with the procedures to execute Windup._
+These instructions are for Windup core developers who plan to build Windup from source to test code updates. 
 
-Experienced users may jump to xref:quick-execute-review-for-experienced-windup-users[Quick Execute Review for Experienced Windup Users].
+* If you are new to the project and not familiar with the procedures to execute Windup, see link:Execute-Windup[Execute Windup]. It contains complete step-by-step instructions to execute Windup and also provides command line examples.
 
-NOTE: If you used previous versions of Windup, delete the `${user.home}/.forge/addons/` directory. Otherwise you may see errors like the following when you execute Windup:  
-           _Command: windup-migrate-app was not found_
-
-==== Unzip the Windup Distribution
-
-1. Follow the procedures to link:Dev-Build-Windup-from-Source[build Windup from source]. This creates a `windup-distribution-2.0.0-SNAPSHOT-offline.zip` file in the Windup source `dist/target` directory. Note, the version may be different than the one used in these instructions.
-2. Unzip the `dist/target/windup-distribution-2.0.0-SNAPSHOT-offline.zip` ZIP file.
-
-==== Run Windup
-
-1. Open a terminal and navigate to the unzipped `windup-distribution-2.0.0-SNAPSHOT/` directory. 
-2. Type the following command to start Windup:
-+
----------------------------------------------------------------------------
-For Linux:     $ bin/windup
-For Windows:   > bin\windup.bat
----------------------------------------------------------------------------
-3. You are presented with the following prompt.
-+
----------------------------------------------------------------------------
-Using Windup at /home/username/windup/dist/target/windup-distribution-2.0.0-SNAPSHOT
-
- _       ___           __          
-| |     / (_)___  ____/ /_  ______ 
-| | /| / / / __ \/ __  / / / / __ \
-| |/ |/ / / / / / /_/ / /_/ / /_/ /
-|__/|__/_/_/ /_/\__,_/\__,_/ .___/ 
-                          /_/      
-
-JBoss Windup, version [ 2.0.0-SNAPSHOT ] - JBoss, by Red Hat, Inc. [ http://windup.jboss.org ]
-
-[windup-distribution-2.0.0-SNAPSHOT]$ 
----------------------------------------------------------------------------
-
-4.  The syntax to evaluate an application using the Windup tool requires that you specify the location of the input archive or folder, the location of a folder to contain the output reporting information, and the application packages to evaluate. At the prompt, type:
+* Experienced users who need a refresher can follow the steps below.
 +
-------------
-windup-migrate-app --input INPUT_ARCHIVE_OR_FOLDER --output OUTPUT_REPORT_DIRECTORY --packages PACKAGE_1 PACKAGE_2 PACKAGE_N
-------------
-+
-Where:
-
-* `INPUT_ARCHIVE_OR_FOLDER` is the fully qualified application archive or source path
-* `OUTPUT_REPORT_DIRECTORY` is the fully qualified path to the folder that will contain the the report information produced by Windup.
-* `PACKAGE_1`, `PACKAGE_2`, `PACKAGE_N` are the packages to be evaluated by Windup.
-+
-See xref:windup-command-examples[Windup Command Examples] below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.
-
-5. You should see the following result upon completion of the command:
-+
-------------
-***SUCCESS*** Windup execution successful!
-------------
-
-6. To exit Windup, type
-+
-------------
-exit
-------------
-
-7.  Open the `OUTPUT_REPORT_DIRECTORY/index.html` file in a browser to access the report.
-The following subdirectories in the `OUTPUT_REPORT_DIRECTORY` contain the supporting information for the report:
-
-        OUTPUT_REPORT_DIRECTORY
-            graph/
-            renderedGraph/
-            reports/
-            stats/
-            index.html
-
-8. For details on how to evaluate the report data, see link:Review-the-Report[Review the Report].
-
-==== Run Windup in Batch Mode (for a shell script)
-
-1. Open a terminal and navigate to the unzipped `windup-distribution-2.0.0-SNAPSHOT/` directory. 
-2. Type the following command to run Windup in batch mode:
-+
----------------------------------------------------------------------------
-For Linux:     $ bin/windup --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
-For Windows:   > bin\windup.bat --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
----------------------------------------------------------------------------
-
-==== Windup Help
-
-To see the list of available parameters for the `windup-migrate-app` command, execute the following command in the Windup prompt:
-
-    man windup-migrate-app
-
-[[windup-command-examples]]
-==== Windup Command Examples
-
-The following Windup command examples report against applications located in the https://github.com/windup/windup/tree/master/test-files[Windup source test-files] directory.
-
-===== Source Code Example
-
-The following command runs against the https://github.com/windup/windup/tree/master/test-files/seam-booking-5.2[seam-booking-5.2] application source code. It evaluates all `org.jboss.seam` packages and creates a folder named 'seam-booking-report' in the `/home/username/windup-reports/` directory to contain the reporting output.
-
-   windup-migrate-app --input /home/username/windup-source/test-files/seam-booking-5.2/ --output /home/username/windup-reports/seam-booking-report --packages org.jboss.seam
-
-===== Archive Example
-
-The following command runs against the https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] EAR archive. It evaluates all `com.acme` and `org.apache` packages and creates a folder named 'jee-example-app-1.0.0.ear-report' in the `/home/username/windup-reports/` directory to contain the reporting output.
-
-    windup-migrate-app --input /home/username/windup-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/windup-reports/jee-example-app-1.0.0.ear-report --packages com.acme org.apache
-
-[[quick-execute-review-for-experienced-windup-users]]
-==== Quick Execute Review for Experienced Windup Users
 ------------------
 mkdir tmp
 cd tmp
@@ -123,13 +18,15 @@ bin/windup.sh
 ## Execute Windup
 $ windup-migrate-app --input /home/username/work/Migration/TestApps/_apps/BradApp --output Report --packages org com net
 
-## Exit forge
+## Exit Windup
 $ exit
 
 ## View the Report
 firefox Report/index.html
 ------------------
 
+////
+I believe the following is obsolete
 ==== Execute Windup as an Installed Forge Add-on
 
 ------------------
@@ -158,4 +55,4 @@ $ exit
 ## View the Report
 firefox Report/index.html
 ------------------
-
+////
diff --git a/docs/Dev-Windup-Documentation-Process.adoc b/docs/Dev-Windup-Documentation-Process.adoc
@@ -45,13 +45,13 @@ git checkout -b gh-pages windup
 * If the directory does not yet exist, create a docs/WINDUP-RELEASE-html/ directory.
 +
 ----
-mkdir -p docs/2.0.0.Beta6/html (if it doesn't exist!)
+mkdir -p docs/2.0.0.VERSION/html (if it doesn't exist!)
 ----
 
 * Copy any new images, stylesheets, and html files from windup-documentation:
 +
 ----
-cp ../windup-documentation/html/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.Beta6/html
+cp ../windup-documentation/html/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.VERSION/html
 ----
 
 * Add the updated files to GitHub.
@@ -72,4 +72,4 @@ git commit -m "Update message..."
 git push upstream gh-pages
 ----
 
-* View the documentation at http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupUserGuide.html
+* View the documentation at http://windup.github.io/windup/docs/2.0.0.VERSION/html/WindupUserGuide.html
diff --git a/docs/Dev-Windup-Project-Information.adoc b/docs/Dev-Windup-Project-Information.adoc
@@ -11,7 +11,7 @@ See the _Core-Developer-Guide_ for details on how to contribute to the Windup pr
 
 The Windup documentation is currently located here in the Windup project https://github.com/windup/windup/wiki/[Wiki].
 
-For additional information, refer to the link:http://windup.github.io/windup/docs/javadoc/2.0.0.Beta2/[Javadoc].
+For additional information, refer to the Windup link:http://windup.github.io/windup/docs/javadoc/latest/index.html[Javadoc].
 
 ==== Website
 

diff --git a/docs/Execute-Windup.adoc b/docs/Execute-Windup.adoc
@@ -1,15 +1,17 @@
 [[Execute-Windup]]
 === Execute Windup
 
-These instructions are for users who run Windup using the tool extracted from the ZIP download.
+NOTE: If you used previous versions of Windup, delete the `${user.home}/.forge/addons/` directory. Otherwise you may see errors like the following when you execute Windup:  
+           _Command: windup-migrate-app was not found_
 
 ==== Prerequisites
 
 Before you begin, you must gather the following information.
 
 . Windup requires that you specify the fully qualified path of the application archive or folder you plan to migrate. This is passed using the `--input` argument on the command line.
 
-. You must also specify the fully qualified path to a folder that will contain the resulting report information. If the folder does not exist, it is created by Windup. This path is passed using the `--output` argument on the command line.
+. You also specify the fully qualified path to a folder that will contain the resulting report information. If the folder does not exist, it is created by Windup. If the folder exists, it is deleted and recreated by Windup, so be careful not to specify a directory that contains important information!
+This path is passed using the `--output` argument on the command line.
 
 . You must also provide a list of the application packages to be evaluated. 
 
@@ -33,7 +35,7 @@ For Windows:  C:\WINDUP_HOME\bin> windup
 . You are presented with the following prompt.
 +
 ---------------------------------------------------------------------------
-Using Windup at /home/username/windup-distribution-VERSION
+Using Windup at WINDUP_HOME
 
  _       ___           __          
 | |     / (_)___  ____/ /_  ______ 
@@ -42,9 +44,9 @@ Using Windup at /home/username/windup-distribution-VERSION
 |__/|__/_/_/ /_/\__,_/\__,_/ .___/ 
                           /_/      
 
-JBoss Windup, version [ VERSION ] - JBoss, by Red Hat, Inc. [ http://windup.jboss.org ]
+JBoss Windup, version [ 2.0.0-VERSION ] - JBoss, by Red Hat, Inc. [ http://windup.jboss.org ]
 
-[windup-distribution-VERSION]$ 
+[windup-distribution-2.0.0-VERSION]$ 
 ---------------------------------------------------------------------------
 
 . The syntax to evaluate an application using the Windup tool requires that you specify the location of the input archive or source code folder, the location of a folder to contain the output reporting information, and the application packages to evaluate. To evaluate an application archive, use the following syntax:
@@ -98,6 +100,18 @@ The following subdirectories in the `OUTPUT_REPORT_DIRECTORY` contain the suppor
 
 . For details on how to evaluate the report data, see link:Review-the-Report[Review the Report].
 
+==== Run Windup in Batch Mode 
+
+Windup can be also executed in batch mode within a shell or batch script using the `--evaluate` argument as follows.
+
+. Open a terminal and navigate to the WINDUP_HOME directory. 
+. Type the following command to run Windup in batch mode:
++
+---------------------------------------------------------------------------
+For Linux:     $ bin/windup --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
+For Windows:   > bin\windup.bat --evaluate "windup-migrate-app --input INPUT_ARCHIVE --output OUTPUT_REPORT --packages PACKAGE_1 PACKAGE_2 PACKAGE_N"
+---------------------------------------------------------------------------
+
 ==== Windup Help
 
 To see the list of available parameters for the `windup-migrate-app` command, execute the following command in the Windup prompt:
@@ -121,8 +135,18 @@ The following command runs against the https://github.com/windup/windup/blob/mas
 
     windup-migrate-app --input /home/username/windup-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/windup-reports/jee-example-app-1.0.0.ear-report --packages com.acme org.apache
 
+===== Windup Batch Example
+
+The following Windup batch command runs against the https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] EAR archive. It evaluates all `com.acme` and `org.apache` packages and creates a folder named 'jee-example-app-1.0.0.ear-report' in the `/home/username/windup-reports/` directory to contain the reporting output.
+
+----
+For Linux: $ bin/windup --evaluate "windup-migrate-app --input /home/username/windup-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/windup-reports/jee-example-app-1.0.0.ear-report --packages com.acme org.apache"
+For Windows: > bin\windup.bat --evaluate "windup-migrate-app --input \windup-source\test-files\jee-example-app-1.0.0.ear --output \windup-reports\jee-example-app-1.0.0.ear-report --packages com.acme org.apache
+----
+
 ===== Windup Quickstart Examples
 
 For more concrete examples, see the Windup quickstarts located on GitHub here: https://github.com/windup/windup-quickstarts. If you prefer, you can download the https://github.com/windup/windup-quickstarts/releases/tag/2.0.0.Alpha1[2.0.0.Alpha1 release] ZIP or TAR  distribution of the quickstarts.
 
-The quickstarts provide examples of Java-based and XML-based rule addons you can run and test using Windup. The README instructions provide a step-by-step guide to run the quickstart example. You can also look through the code examples and use them as a starting point for creating your own rule addons.
+The quickstarts provide examples of Java-based and XML-based rule addons you can run and test using Windup. The README instructions provide a step-by-step guide to run the quickstart example. You can also look through the code examples and use them as a starting point for creating your own rule addons.
+