From 9fb2773c65b55add3755d5e94ddaa8a24898f0b8 Mon Sep 17 00:00:00 2001 From: Sande Gilda Date: Wed, 18 Mar 2015 12:54:43 -0400 Subject: [PATCH] Doc updates for 2.1.0.Final --- docs/Windup-Rules-Development-Guide.adoc | 4 --- html/WindupCoreDevelopmentGuide.html | 2 +- html/WindupRulesDevelopmentGuide.html | 34 ++++++++++++------------ html/WindupUserGuide.html | 2 +- scripts/windupDocPublish.sh | 1 + 5 files changed, 20 insertions(+), 23 deletions(-) diff --git a/docs/Windup-Rules-Development-Guide.adoc b/docs/Windup-Rules-Development-Guide.adoc index 7d7da4e6cf..e04823e37f 100644 --- a/docs/Windup-Rules-Development-Guide.adoc +++ b/docs/Windup-Rules-Development-Guide.adoc @@ -1,8 +1,5 @@ = Windup Rules Development Guide -:imagesdir: images -:includedir: . - :toc: :toclevels: 4 :numbered: @@ -12,7 +9,6 @@ This guide is for engineers, consultants, and others who plan to create custom rules for Windup 2.0. -// include::{includedir}/What-is-Windup.adoc[tabsize=4] include::What-is-Windup.adoc[tabsize=4] include::Features-of-Windup-2.0.adoc[tabsize=4] diff --git a/html/WindupCoreDevelopmentGuide.html b/html/WindupCoreDevelopmentGuide.html index f01b51c018..7a329ba71f 100644 --- a/html/WindupCoreDevelopmentGuide.html +++ b/html/WindupCoreDevelopmentGuide.html @@ -6039,7 +6039,7 @@

Reporting Terms

diff --git a/html/WindupRulesDevelopmentGuide.html b/html/WindupRulesDevelopmentGuide.html index 08449777c0..005f4bdf63 100644 --- a/html/WindupRulesDevelopmentGuide.html +++ b/html/WindupRulesDevelopmentGuide.html @@ -498,7 +498,7 @@

1. Overview

custom rules for Windup 2.0.

-

Windup Logo

+

Windup Logo

@@ -1319,7 +1319,7 @@

2.3.2. Open the Report

Use your favorite browser to open the index.html file located in the output report directory. You should see something like the following:

-

Report Index Page

+

Report Index Page

Click on the link under the Name column to view the Windup application report page.

@@ -1346,7 +1346,7 @@
Application Report Page

The following is an example of a Windup Application Report.

-

Report Summary Page

+

Report Summary Page

@@ -1409,7 +1409,7 @@
Archive Analysis Sections

The following is an example of the archive analysis summary section of a Windup Report. In this example, it’s the analysis of the WINDUP_SOURCE/test-files/jee-example-app-1.0.0.ear/jee-example-services.jar.

-

Report Archive Page

+

Report Archive Page

@@ -1431,13 +1431,13 @@
File Analysis Pages

In this example, warnings appear at the import of weblogic.application.ApplicationLifecycleEvent and report that the class is proprietary to WebLogic and must be removed.

-

File Detail - Part 1

+

File Detail - Part 1

Later in the code, warnings appear for the creation of the InitialContext and for the object name when registering and unregistering an MBeans

-

File Detail - Part 2

+

File Detail - Part 2

@@ -1452,7 +1452,7 @@
Rule Provider Execution Report

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

-

RuleProvider Report

+

RuleProvider Report

@@ -1467,7 +1467,7 @@
Individual File Analysis Reports

You can directly access the the file analysis report pages described above by browsing for them by name in the OUTPUT_REPORT_DIRECTORY/reports/ directory. Because the same common file names can exist in multiple archives, for example "manifest.mf" or "web.xml", Windup adds a unique numeric suffix to each report file name.

-

Report Directory File List

+

Report Directory File List

include::http://windup.github.io/windup/docs/javadoc/latest/[Windup API JavaDoc reference]: The JavaDoc can serve as a reference for creating Java-based rule addons.

@@ -3712,7 +3712,7 @@

6.1.2. Open the Report

Use your favorite browser to open the index.html file located in the output report directory. You should see something like the following:

-

Report Index Page

+

Report Index Page

Click on the link under the Name column to view the Windup application report page.

@@ -3739,7 +3739,7 @@
Application Report Page

The following is an example of a Windup Application Report.

-

Report Summary Page

+

Report Summary Page

@@ -3802,7 +3802,7 @@
Archive Analysis Sections

The following is an example of the archive analysis summary section of a Windup Report. In this example, it’s the analysis of the WINDUP_SOURCE/test-files/jee-example-app-1.0.0.ear/jee-example-services.jar.

-

Report Archive Page

+

Report Archive Page

@@ -3824,13 +3824,13 @@
File Analysis Pages

In this example, warnings appear at the import of weblogic.application.ApplicationLifecycleEvent and report that the class is proprietary to WebLogic and must be removed.

-

File Detail - Part 1

+

File Detail - Part 1

Later in the code, warnings appear for the creation of the InitialContext and for the object name when registering and unregistering an MBeans

-

File Detail - Part 2

+

File Detail - Part 2

@@ -3845,7 +3845,7 @@
Rule Provider Execution Report

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

-

RuleProvider Report

+

RuleProvider Report

@@ -3860,7 +3860,7 @@
Individual File Analysis ReportsYou can directly access the the file analysis report pages described above by browsing for them by name in the OUTPUT_REPORT_DIRECTORY/reports/ directory. Because the same common file names can exist in multiple archives, for example "manifest.mf" or "web.xml", Windup adds a unique numeric suffix to each report file name.

-

Report Directory File List

+

Report Directory File List

@@ -4635,7 +4635,7 @@

10.3. Windup Models

The complete and up-to-date list of models is in Javadoc.

-

Windup Models Graphic

+

Windup Models Graphic

10.3.1. Meta Models

@@ -4672,7 +4672,7 @@

10.3.4. Custom Models (coming from Ad

diff --git a/html/WindupUserGuide.html b/html/WindupUserGuide.html index 83c408d892..37be263fec 100644 --- a/html/WindupUserGuide.html +++ b/html/WindupUserGuide.html @@ -1686,7 +1686,7 @@

OCPsoft Rewrite

diff --git a/scripts/windupDocPublish.sh b/scripts/windupDocPublish.sh index 42d8847497..2801103371 100755 --- a/scripts/windupDocPublish.sh +++ b/scripts/windupDocPublish.sh @@ -50,6 +50,7 @@ git add docs git commit -m "Update the docs for release $3" echo "The following are manual steps: " +echo " Navigate to the local windup source GitHub directory and issue the following command. echo " git push origin HEAD" echo " (issue a pull and verify)" echo " git push upstream gh-pages"