diff --git a/About-the-WINDUP_HOME-Variable.adoc b/docs/About-the-WINDUP_HOME-Variable.adoc similarity index 100% rename from About-the-WINDUP_HOME-Variable.adoc rename to docs/About-the-WINDUP_HOME-Variable.adoc diff --git a/Dev-Debugging-and-Profiling.adoc b/docs/Dev-Debugging-and-Profiling.adoc similarity index 100% rename from Dev-Debugging-and-Profiling.adoc rename to docs/Dev-Debugging-and-Profiling.adoc diff --git a/Dev-Dependencies.adoc b/docs/Dev-Dependencies.adoc similarity index 100% rename from Dev-Dependencies.adoc rename to docs/Dev-Dependencies.adoc diff --git a/Dev-Troubleshoot-Windup-Issues.adoc b/docs/Dev-Troubleshoot-Windup-Issues.adoc similarity index 100% rename from Dev-Troubleshoot-Windup-Issues.adoc rename to docs/Dev-Troubleshoot-Windup-Issues.adoc diff --git a/Dev-Windup-Architectural-Components.adoc b/docs/Dev-Windup-Architectural-Components.adoc similarity index 100% rename from Dev-Windup-Architectural-Components.adoc rename to docs/Dev-Windup-Architectural-Components.adoc diff --git a/Execute-Windup.adoc b/docs/Execute-Windup.adoc similarity index 100% rename from Execute-Windup.adoc rename to docs/Execute-Windup.adoc diff --git a/Features-of-Windup-2.0.adoc b/docs/Features-of-Windup-2.0.adoc similarity index 100% rename from Features-of-Windup-2.0.adoc rename to docs/Features-of-Windup-2.0.adoc diff --git a/Get-Involved.adoc b/docs/Get-Involved.adoc similarity index 100% rename from Get-Involved.adoc rename to docs/Get-Involved.adoc diff --git a/Glossary.adoc b/docs/Glossary.adoc similarity index 100% rename from Glossary.adoc rename to docs/Glossary.adoc diff --git a/Install-Windup.adoc b/docs/Install-Windup.adoc similarity index 100% rename from Install-Windup.adoc rename to docs/Install-Windup.adoc diff --git a/Install-and-Configure-Maven.adoc b/docs/Install-and-Configure-Maven.adoc similarity index 100% rename from Install-and-Configure-Maven.adoc rename to docs/Install-and-Configure-Maven.adoc diff --git a/Known-Issues.adoc b/docs/Known-Issues.adoc similarity index 100% rename from Known-Issues.adoc rename to docs/Known-Issues.adoc diff --git a/Migration-Planning-Guide.asciidoc b/docs/Migration-Planning-Guide.asciidoc similarity index 100% rename from Migration-Planning-Guide.asciidoc rename to docs/Migration-Planning-Guide.asciidoc diff --git a/README.adoc b/docs/README.adoc similarity index 100% rename from README.adoc rename to docs/README.adoc diff --git a/Report-Issues-with-Windup.adoc b/docs/Report-Issues-with-Windup.adoc similarity index 100% rename from Report-Issues-with-Windup.adoc rename to docs/Report-Issues-with-Windup.adoc diff --git a/Review-the-Report.adoc b/docs/Review-the-Report.adoc similarity index 100% rename from Review-the-Report.adoc rename to docs/Review-the-Report.adoc diff --git a/Review-the-Windup-Quickstarts.adoc b/docs/Review-the-Windup-Quickstarts.adoc similarity index 100% rename from Review-the-Windup-Quickstarts.adoc rename to docs/Review-the-Windup-Quickstarts.adoc diff --git a/Rules-Available-Rules-Utilities.adoc b/docs/Rules-Available-Rules-Utilities.adoc similarity index 100% rename from Rules-Available-Rules-Utilities.adoc rename to docs/Rules-Available-Rules-Utilities.adoc diff --git a/Rules-Basic-Rule-Execution-Flow-Patterns.adoc b/docs/Rules-Basic-Rule-Execution-Flow-Patterns.adoc similarity index 100% rename from Rules-Basic-Rule-Execution-Flow-Patterns.adoc rename to docs/Rules-Basic-Rule-Execution-Flow-Patterns.adoc diff --git a/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc b/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc similarity index 100% rename from Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc rename to docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc diff --git a/Rules-Create-a-Basic-XML-Rule.adoc b/docs/Rules-Create-a-Basic-XML-Rule.adoc similarity index 100% rename from Rules-Create-a-Basic-XML-Rule.adoc rename to docs/Rules-Create-a-Basic-XML-Rule.adoc diff --git a/Rules-Create-an-Advanced-Ruleset.adoc b/docs/Rules-Create-an-Advanced-Ruleset.adoc similarity index 100% rename from Rules-Create-an-Advanced-Ruleset.adoc rename to docs/Rules-Create-an-Advanced-Ruleset.adoc diff --git a/Rules-Development-Guide.asciidoc b/docs/Rules-Development-Guide.asciidoc similarity index 100% rename from Rules-Development-Guide.asciidoc rename to docs/Rules-Development-Guide.asciidoc diff --git a/Rules-Java-based-Rule-Structure.adoc b/docs/Rules-Java-based-Rule-Structure.adoc similarity index 100% rename from Rules-Java-based-Rule-Structure.adoc rename to docs/Rules-Java-based-Rule-Structure.adoc diff --git a/Rules-Rule-Execution-Lifecycle.adoc b/docs/Rules-Rule-Execution-Lifecycle.adoc similarity index 100% rename from Rules-Rule-Execution-Lifecycle.adoc rename to docs/Rules-Rule-Execution-Lifecycle.adoc diff --git a/Rules-Rule-Story-Points.adoc b/docs/Rules-Rule-Story-Points.adoc similarity index 100% rename from Rules-Rule-Story-Points.adoc rename to docs/Rules-Rule-Story-Points.adoc diff --git a/Rules-Windup-Models.adoc b/docs/Rules-Windup-Models.adoc similarity index 100% rename from Rules-Windup-Models.adoc rename to docs/Rules-Windup-Models.adoc diff --git a/User-Guide.asciidoc b/docs/User-Guide.asciidoc similarity index 100% rename from User-Guide.asciidoc rename to docs/User-Guide.asciidoc diff --git a/What-is-Windup.adoc b/docs/What-is-Windup.adoc similarity index 100% rename from What-is-Windup.adoc rename to docs/What-is-Windup.adoc diff --git a/Windup-Processing-Overview.adoc b/docs/Windup-Processing-Overview.adoc similarity index 100% rename from Windup-Processing-Overview.adoc rename to docs/Windup-Processing-Overview.adoc diff --git a/Windup-Rules-Development-Guide.adoc b/docs/Windup-Rules-Development-Guide.adoc similarity index 100% rename from Windup-Rules-Development-Guide.adoc rename to docs/Windup-Rules-Development-Guide.adoc diff --git a/Windup-User-Guide.adoc b/docs/Windup-User-Guide.adoc similarity index 100% rename from Windup-User-Guide.adoc rename to docs/Windup-User-Guide.adoc diff --git a/docbook-xsl.css b/docs/docbook-xsl.css similarity index 100% rename from docbook-xsl.css rename to docs/docbook-xsl.css diff --git a/images/.DS_Store b/docs/images/.DS_Store similarity index 100% rename from images/.DS_Store rename to docs/images/.DS_Store diff --git a/images/2-extending-s1.png b/docs/images/2-extending-s1.png similarity index 100% rename from images/2-extending-s1.png rename to docs/images/2-extending-s1.png diff --git a/images/2-extending-s2.png b/docs/images/2-extending-s2.png similarity index 100% rename from images/2-extending-s2.png rename to docs/images/2-extending-s2.png diff --git a/images/5-main-menu.png b/docs/images/5-main-menu.png similarity index 100% rename from images/5-main-menu.png rename to docs/images/5-main-menu.png diff --git a/images/6-archive-overview.png b/docs/images/6-archive-overview.png similarity index 100% rename from images/6-archive-overview.png rename to docs/images/6-archive-overview.png diff --git a/images/6-java-classification-1.png b/docs/images/6-java-classification-1.png similarity index 100% rename from images/6-java-classification-1.png rename to docs/images/6-java-classification-1.png diff --git a/images/6-java-hint1.png b/docs/images/6-java-hint1.png similarity index 100% rename from images/6-java-hint1.png rename to docs/images/6-java-hint1.png diff --git a/images/6-java-hint2.png b/docs/images/6-java-hint2.png similarity index 100% rename from images/6-java-hint2.png rename to docs/images/6-java-hint2.png diff --git a/images/6-resource-classification.png b/docs/images/6-resource-classification.png similarity index 100% rename from images/6-resource-classification.png rename to docs/images/6-resource-classification.png diff --git a/images/directory-setup.png b/docs/images/directory-setup.png similarity index 100% rename from images/directory-setup.png rename to docs/images/directory-setup.png diff --git a/images/report-directory-file-list.png b/docs/images/report-directory-file-list.png similarity index 100% rename from images/report-directory-file-list.png rename to docs/images/report-directory-file-list.png diff --git a/images/report-example.png b/docs/images/report-example.png similarity index 100% rename from images/report-example.png rename to docs/images/report-example.png diff --git a/images/report-index-page.png b/docs/images/report-index-page.png similarity index 100% rename from images/report-index-page.png rename to docs/images/report-index-page.png diff --git a/images/report-javaee-ear-01-summary.png b/docs/images/report-javaee-ear-01-summary.png similarity index 100% rename from images/report-javaee-ear-01-summary.png rename to docs/images/report-javaee-ear-01-summary.png diff --git a/images/report-javaee-ear-02-ear.png b/docs/images/report-javaee-ear-02-ear.png similarity index 100% rename from images/report-javaee-ear-02-ear.png rename to docs/images/report-javaee-ear-02-ear.png diff --git a/images/report-javaee-ear-03-services-jar.png b/docs/images/report-javaee-ear-03-services-jar.png similarity index 100% rename from images/report-javaee-ear-03-services-jar.png rename to docs/images/report-javaee-ear-03-services-jar.png diff --git a/images/report-javaee-ear-04-war.png b/docs/images/report-javaee-ear-04-war.png similarity index 100% rename from images/report-javaee-ear-04-war.png rename to docs/images/report-javaee-ear-04-war.png diff --git a/images/report-javaee-ear-file-detail-part1.png b/docs/images/report-javaee-ear-file-detail-part1.png similarity index 100% rename from images/report-javaee-ear-file-detail-part1.png rename to docs/images/report-javaee-ear-file-detail-part1.png diff --git a/images/report-javaee-ear-file-detail-part2.png b/docs/images/report-javaee-ear-file-detail-part2.png similarity index 100% rename from images/report-javaee-ear-file-detail-part2.png rename to docs/images/report-javaee-ear-file-detail-part2.png diff --git a/images/report-javaee-ear-ruleprovider.png b/docs/images/report-javaee-ear-ruleprovider.png similarity index 100% rename from images/report-javaee-ear-ruleprovider.png rename to docs/images/report-javaee-ear-ruleprovider.png diff --git a/images/report-javaee-ear-summary.png b/docs/images/report-javaee-ear-summary.png similarity index 100% rename from images/report-javaee-ear-summary.png rename to docs/images/report-javaee-ear-summary.png diff --git a/images/rh-logo.png b/docs/images/rh-logo.png similarity index 100% rename from images/rh-logo.png rename to docs/images/rh-logo.png diff --git a/images/windup-logo-large.png b/docs/images/windup-logo-large.png similarity index 100% rename from images/windup-logo-large.png rename to docs/images/windup-logo-large.png diff --git a/images/windup-logo-wiki-header.jpg b/docs/images/windup-logo-wiki-header.jpg similarity index 100% rename from images/windup-logo-wiki-header.jpg rename to docs/images/windup-logo-wiki-header.jpg diff --git a/WindupRulesDevelopmentGuide.html b/html/WindupRulesDevelopmentGuide.html similarity index 100% rename from WindupRulesDevelopmentGuide.html rename to html/WindupRulesDevelopmentGuide.html diff --git a/WindupUserGuide.html b/html/WindupUserGuide.html similarity index 100% rename from WindupUserGuide.html rename to html/WindupUserGuide.html diff --git a/scripts/windupDocUpdate.sh b/scripts/windupDocUpdate.sh new file mode 100755 index 0000000000..a78abc49ee --- /dev/null +++ b/scripts/windupDocUpdate.sh @@ -0,0 +1,98 @@ + +# First, copy the latest files from the Windup Wiki pages +# This script assumes the windup.wiki and windup-documentation directories are at the same level. + +# Fetch the latest Wiki data +cd ~/GitRepos/windup.wiki +git fetch upstream +git reset --hard upstream/master +cd ../windup-documentation + +# Images +#cp -r ../windup.wiki/images docs/ + +# Stylesheet +#cp ../windup.wiki/*.css docs/ + +# User Guide + +## asciidoctor -t -dbook -a toc -o WindupUserGuide.html Windup-User-Guide.adoc + +## Overview +cp ../windup.wiki/User-Guide.asciidoc docs/ +cp ../windup.wiki/What-is-Windup.asciidoc docs/What-is-Windup.adoc +cp ../windup.wiki/Features-of-Windup-2.0.asciidoc docs/Features-of-Windup-2.0.adoc +cp ../windup.wiki/Windup-Processing-Overview.asciidoc docs/Windup-Processing-Overview.adoc +cp ../windup.wiki/Get-Involved.asciidoc docs/Get-Involved.adoc +cp ../windup.wiki/Report-Issues-with-Windup.asciidoc docs/Report-Issues-with-Windup.adoc +cp ../windup.wiki/About-the-WINDUP_HOME-Variable.asciidoc docs/About-the-WINDUP_HOME-Variable.adoc +## Run Windup +cp ../windup.wiki/Install-Windup.asciidoc docs/Install-Windup.adoc +cp ../windup.wiki/Execute-Windup.asciidoc docs/Execute-Windup.adoc +cp ../windup.wiki/Review-the-Report.asciidoc docs/Review-the-Report.adoc +## Addtional Resources +cp ../windup.wiki/Review-the-Windup-Quickstarts.asciidoc docs/Review-the-Windup-Quickstarts.adoc +cp ../windup.wiki/Known-Issues.asciidoc docs/Known-Issues.adoc +cp ../windup.wiki/Glossary.asciidoc docs/Glossary.adoc +## Appendix +cp ../windup.wiki/Dev-Windup-Architectural-Components.asciidoc docs/Dev-Windup-Architectural-Components.adoc +cp ../windup.wiki/Rules-Rule-Story-Points.asciidoc docs/Rules-Rule-Story-Points.adoc + +# Rules Development Guide + +## asciidoctor -t -dbook -a toc -o WindupRulesDevelopmentGuide.html Windup-Rules-Development-Guide.adoc + +## Overview +cp ../windup.wiki/Rules-Development-Guide.asciidoc docs/ +cp ../windup.wiki/What-is-Windup.asciidoc docs/What-is-Windup.adoc +cp ../windup.wiki/Features-of-Windup-2.0.asciidoc docs/Features-of-Windup-2.0.adoc +cp ../windup.wiki/Get-Involved.asciidoc docs/Get-Involved.adoc +cp ../windup.wiki/Report-Issues-with-Windup.asciidoc docs/Report-Issues-with-Windup.adoc +cp ../windup.wiki/About-the-WINDUP_HOME-Variable.asciidoc docs/About-the-WINDUP_HOME-Variable.adoc +## Get Started +cp ../windup.wiki/Install-Windup.asciidoc docs/Install-Windup.adoc +cp ../windup.wiki/Execute-Windup.asciidoc docs/Execute-Windup.adoc +cp ../windup.wiki/Review-the-Report.asciidoc docs/Review-the-Report.adoc +## Configure Your System for Java-based Rules +cp ../windup.wiki/Install-and-Configure-Maven.asciidoc docs/Install-and-Configure-Maven.adoc +## Understand the Rule Processing +cp ../windup.wiki/Windup-Processing-Overview.asciidoc docs/Windup-Processing-Overview.adoc +cp ../windup.wiki/Rules-Rule-Execution-Lifecycle.asciidoc docs/Rules-Rule-Execution-Lifecycle.adoc +cp ../windup.wiki/Rules-Rule-Story-Points.asciidoc docs/Rules-Rule-Story-Points.adoc +#Create and Test Java Rule Addons +cp ../windup.wiki/Rules-Java-based-Rule-Structure.asciidoc docs/Rules-Java-based-Rule-Structure.adoc +cp ../windup.wiki/Rules-Basic-Rule-Execution-Flow-Patterns.asciidoc docs/Rules-Basic-Rule-Execution-Flow-Patterns.adoc +cp ../windup.wiki/Rules-Create-a-Basic-Java-based-Rule-Add-on.asciidoc docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc +cp ../windup.wiki/Rules-Create-an-Advanced-Ruleset.asciidoc docs/Rules-Create-an-Advanced-Ruleset.adoc +## Create and Test XML Rules +cp ../windup.wiki/Rules-Create-a-Basic-XML-Rule.asciidoc docs/Rules-Create-a-Basic-XML-Rule.adoc +## Debugging and Troubleshooting +cp ../windup.wiki/Dev-Debugging-and-Profiling.asciidoc docs/Dev-Debugging-and-Profiling.adoc +cp ../windup.wiki/Dev-Troubleshoot-Windup-Issues.asciidoc docs/Dev-Troubleshoot-Windup-Issues.adoc +## Addtional Resources +cp ../windup.wiki/Rules-Available-Rules-Utilities.asciidoc docs/Rules-Available-Rules-Utilities.adoc +cp ../windup.wiki/Review-the-Windup-Quickstarts.asciidoc docs/Review-the-Windup-Quickstarts.adoc +cp ../windup.wiki/Known-Issues.asciidoc docs/Known-Issues.adoc +cp ../windup.wiki/Glossary.asciidoc docs/Glossary.adoc +## Appendix +cp ../windup.wiki/Dev-Windup-Architectural-Components.asciidoc docs/Dev-Windup-Architectural-Components.adoc +cp ../windup.wiki/Dev-Dependencies.asciidoc docs/Dev-Dependencies.adoc +cp ../windup.wiki/Rules-Windup-Models.asciidoc docs/Rules-Windup-Models.adoc + +#cp ../windup.wiki/ +#cp ../windup.wiki/ +#cp ../windup.wiki/ +#cp ../windup.wiki/ + +## Find the internal links within pages +# grep 'xref:[a-z]' `find . -name '*.adoc'` +# Add a leading undescore and replace the dashes with underscores + +## Search the internal links and make sure the linked pages are part of the book +# grep 'link:' `find . -name '*.adoc'` + +## Replace the links to other pages with xrefs: +# find . -name '*.adoc' -print | xargs sed -i 's/link:/xref:/g' +# grep 'xref:' `find . -name '*.adoc'` + +