Skip to content
Merged
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
4 changes: 0 additions & 4 deletions docs/Windup-Rules-Development-Guide.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
= Windup Rules Development Guide

:imagesdir: images
:includedir: .

:toc:
:toclevels: 4
:numbered:
Expand All @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion html/WindupCoreDevelopmentGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -6039,7 +6039,7 @@ <h4 id="_reporting_terms">Reporting Terms</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2015-03-17 13:12:03 EDT
Last updated 2015-03-18 12:53:09 EDT
</div>
</div>
</body>
Expand Down
34 changes: 17 additions & 17 deletions html/WindupRulesDevelopmentGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ <h2 id="_overview">1. Overview</h2>
custom rules for Windup 2.0.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/windup-logo-wiki-header.jpg" alt="Windup Logo"></span></p>
<p><span class="image"><img src="images/windup-logo-wiki-header.jpg" alt="Windup Logo"></span></p>
</div>
<hr>
<div class="sect2">
Expand Down Expand Up @@ -1319,7 +1319,7 @@ <h4 id="_open_the_report">2.3.2. Open the Report</h4>
<p>Use your favorite browser to open the <code>index.html</code> file located in the output report directory. You should see something like the following:</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-index-page.png" alt="Report Index Page" width="500"></span></p>
<p><span class="image"><img src="images/report-index-page.png" alt="Report Index Page" width="500"></span></p>
</div>
<div class="paragraph">
<p>Click on the link under the <strong>Name</strong> column to view the Windup application report page.</p>
Expand All @@ -1346,7 +1346,7 @@ <h5 id="_application_report_page">Application Report Page</h5>
<p>The following is an example of a Windup Application Report.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-summary.png" alt="Report Summary Page" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-summary.png" alt="Report Summary Page" width="500"></span></p>
</div>
</div>
<div class="sect4">
Expand Down Expand Up @@ -1409,7 +1409,7 @@ <h5 id="_archive_analysis_sections">Archive Analysis Sections</h5>
<p>The following is an example of the archive analysis summary section of a Windup Report. In this example, it&#8217;s the analysis of the <code>WINDUP_SOURCE/test-files/jee-example-app-1.0.0.ear/jee-example-services.jar</code>.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-03-services-jar.png" alt="Report Archive Page" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-03-services-jar.png" alt="Report Archive Page" width="500"></span></p>
</div>
</div>
<div class="sect4">
Expand All @@ -1431,13 +1431,13 @@ <h5 id="_file_analysis_pages">File Analysis Pages</h5>
<p>In this example, warnings appear at the import of <code>weblogic.application.ApplicationLifecycleEvent</code> and report that the class is proprietary to WebLogic and must be removed.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-file-detail-part1.png" alt="File Detail - Part 1" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-file-detail-part1.png" alt="File Detail - Part 1" width="500"></span></p>
</div>
<div class="paragraph">
<p>Later in the code, warnings appear for the creation of the InitialContext and for the object name when registering and unregistering an MBeans</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-file-detail-part2.png" alt="File Detail - Part 2" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-file-detail-part2.png" alt="File Detail - Part 2" width="500"></span></p>
</div>
</div>
</div>
Expand All @@ -1452,7 +1452,7 @@ <h5 id="_rule_provider_execution_report">Rule Provider Execution Report</h5>
<p>The <code>OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html</code> page provides the list of rule providers that executed when running the Windup migration command against the application.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-ruleprovider.png" alt="RuleProvider Report" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-ruleprovider.png" alt="RuleProvider Report" width="500"></span></p>
</div>
</div>
<div class="sect4">
Expand All @@ -1467,7 +1467,7 @@ <h5 id="_individual_file_analysis_reports">Individual File Analysis Reports</h5>
<p>You can directly access the the file analysis report pages described above by browsing for them by name in the <code>OUTPUT_REPORT_DIRECTORY/reports/</code> 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.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-directory-file-list.png" alt="Report Directory File List" width="500"></span></p>
<p><span class="image"><img src="images/report-directory-file-list.png" alt="Report Directory File List" width="500"></span></p>
</div>
<div class="paragraph">
<p>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.</p>
Expand Down Expand Up @@ -3712,7 +3712,7 @@ <h4 id="_open_the_report_2">6.1.2. Open the Report</h4>
<p>Use your favorite browser to open the <code>index.html</code> file located in the output report directory. You should see something like the following:</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-index-page.png" alt="Report Index Page" width="500"></span></p>
<p><span class="image"><img src="images/report-index-page.png" alt="Report Index Page" width="500"></span></p>
</div>
<div class="paragraph">
<p>Click on the link under the <strong>Name</strong> column to view the Windup application report page.</p>
Expand All @@ -3739,7 +3739,7 @@ <h5 id="_application_report_page_2">Application Report Page</h5>
<p>The following is an example of a Windup Application Report.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-summary.png" alt="Report Summary Page" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-summary.png" alt="Report Summary Page" width="500"></span></p>
</div>
</div>
<div class="sect4">
Expand Down Expand Up @@ -3802,7 +3802,7 @@ <h5 id="_archive_analysis_sections_2">Archive Analysis Sections</h5>
<p>The following is an example of the archive analysis summary section of a Windup Report. In this example, it&#8217;s the analysis of the <code>WINDUP_SOURCE/test-files/jee-example-app-1.0.0.ear/jee-example-services.jar</code>.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-03-services-jar.png" alt="Report Archive Page" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-03-services-jar.png" alt="Report Archive Page" width="500"></span></p>
</div>
</div>
<div class="sect4">
Expand All @@ -3824,13 +3824,13 @@ <h5 id="_file_analysis_pages_2">File Analysis Pages</h5>
<p>In this example, warnings appear at the import of <code>weblogic.application.ApplicationLifecycleEvent</code> and report that the class is proprietary to WebLogic and must be removed.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-file-detail-part1.png" alt="File Detail - Part 1" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-file-detail-part1.png" alt="File Detail - Part 1" width="500"></span></p>
</div>
<div class="paragraph">
<p>Later in the code, warnings appear for the creation of the InitialContext and for the object name when registering and unregistering an MBeans</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-file-detail-part2.png" alt="File Detail - Part 2" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-file-detail-part2.png" alt="File Detail - Part 2" width="500"></span></p>
</div>
</div>
</div>
Expand All @@ -3845,7 +3845,7 @@ <h5 id="_rule_provider_execution_report_3">Rule Provider Execution Report</h5>
<p>The <code>OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html</code> page provides the list of rule providers that executed when running the Windup migration command against the application.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-javaee-ear-ruleprovider.png" alt="RuleProvider Report" width="500"></span></p>
<p><span class="image"><img src="images/report-javaee-ear-ruleprovider.png" alt="RuleProvider Report" width="500"></span></p>
</div>
</div>
<div class="sect4">
Expand All @@ -3860,7 +3860,7 @@ <h5 id="_individual_file_analysis_reports_2">Individual File Analysis Reports</h
<p>You can directly access the the file analysis report pages described above by browsing for them by name in the <code>OUTPUT_REPORT_DIRECTORY/reports/</code> 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.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/report-directory-file-list.png" alt="Report Directory File List" width="500"></span></p>
<p><span class="image"><img src="images/report-directory-file-list.png" alt="Report Directory File List" width="500"></span></p>
</div>
</div>
</div>
Expand Down Expand Up @@ -4635,7 +4635,7 @@ <h3 id="Rules-Windup-Models">10.3. Windup Models</h3>
The complete and up-to-date list of models is in <a href="#http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/graph/model/WindupVertexFrame.html">Javadoc</a>.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/images/WindupModels-NbScreenshot.png" alt="Windup Models Graphic"></span></p>
<p><span class="image"><img src="images/WindupModels-NbScreenshot.png" alt="Windup Models Graphic"></span></p>
</div>
<div class="sect3">
<h4 id="_meta_models">10.3.1. Meta Models</h4>
Expand Down Expand Up @@ -4672,7 +4672,7 @@ <h4 id="_custom_models_coming_from_addons">10.3.4. Custom Models (coming from Ad
</div>
<div id="footer">
<div id="footer-text">
Last updated 2015-03-17 13:12:03 EDT
Last updated 2015-03-18 12:53:09 EDT
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion html/WindupUserGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -1686,7 +1686,7 @@ <h4 id="_ocpsoft_rewrite">OCPsoft Rewrite</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2015-03-17 13:12:03 EDT
Last updated 2015-03-18 12:53:09 EDT
</div>
</div>
</body>
Expand Down
1 change: 1 addition & 0 deletions scripts/windupDocPublish.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down