diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 5ac060877d..fb7b007e5d 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -38,7 +38,13 @@ See xref:windup-command-examples[Windup Command Examples] for more information. * If you have not yet done so, install Ascidoctor + ---- -gem install sciidoctor +gem install asciidoctor +---- + +* Navigate to the root of the windup-documentation directory and check out a branch to work in. ++ +---- +git checkout -b upstream/master ---- * A script is provided that updates the documentation with the latest Wiki updates, automatically replaces internal links, and builds the guides. To run it, navigate to the root of the windup-documentation directory and type: diff --git a/docs/About-the-Windup-Wiki.adoc b/docs/About-the-Windup-Wiki.adoc index dab5ae3f18..16b275457e 100644 --- a/docs/About-the-Windup-Wiki.adoc +++ b/docs/About-the-Windup-Wiki.adoc @@ -32,17 +32,17 @@ The following is a brief overview. * At the beginning of each new Wiki page, add an anchor with the exact page name, including the dashes. This generates the correct anchors that are needed when the pages are combined into a book. - [[Dev-Build-Windup-from-Source]] - === Build Windup from Source + [[Page-Name]] + === Page Name * Wiki generates anchors using dashes for spaces. AsciiDoctor generates a leading underscore and underscores for spaces.When referring to another section within the same page, do not use the `<>` syntax. Instead, create an anchor and use the 'xref:' syntax to provide the link. Replace spaces in the section title with dashes. - Create the anchor at the top of the section using double brackets to force the generation of dashes instead of underscores. +** Create the anchor at the top of the section using double brackets to force the generation of dashes instead of underscores. - [[windup-command-examples]] - ==== Windup Command Examples + [[section-header]] + ==== Section Header - Then use the `xref` to create the link. +** Then use the `xref` to create the link. - See xref:windup-command-examples[Windup Command Examples] for more information. + See xref:section-header[Section Header] for more information. diff --git a/docs/Core-Development-Guide.asciidoc b/docs/Core-Development-Guide.asciidoc index eb2f071a71..ee21eceb81 100644 --- a/docs/Core-Development-Guide.asciidoc +++ b/docs/Core-Development-Guide.asciidoc @@ -29,7 +29,7 @@ repository, IRC, Mailing lists, ... ==== Understand the Windup Architecture and Structure -* link:Dev-Windup-Architectural-Components[Windup Architectural Components] +* link:Windup-Architectural-Components[Windup Architectural Components] * link:Dev-Windup-Project-Structure[Windup Project Structure] ==== Rules and Rulesets diff --git a/docs/Dev-Build-Windup-from-Source.adoc b/docs/Dev-Build-Windup-from-Source.adoc index ac35bbd219..7b00ab291a 100644 --- a/docs/Dev-Build-Windup-from-Source.adoc +++ b/docs/Dev-Build-Windup-from-Source.adoc @@ -19,7 +19,7 @@ Oracle Java SE . Maven 3.1.1 or newer + If you have not yet installed or configured Maven, see -link:Install-and-Configure-Maven[Install and Configure Maven] for details. +xref:Install-and-Configure-Maven[Install and Configure Maven] for details. + If you have installed Maven, you can check the version by typing the following in a command prompt: @@ -37,15 +37,15 @@ Developer Studio 7.1.1] or newer + You must also make sure the IDE embeds Maven 3.1.1 or later. See -link:Install-and-Configure-Maven[Install and Configure Maven] for details. +xref:Install-and-Configure-Maven[Install and Configure Maven] for details. ==== Build Windup Using Maven Command Line . Make sure you have configured Maven as described here: -link:Install-and-Configure-Maven[Install and Configure Maven]. -. Check out Windup source code: `git clone git@github.com:windup/windup.git Windup`. See link:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code] for more info. +xref:Install-and-Configure-Maven[Install and Configure Maven]. +. Check out Windup source code: `git clone git@github.com:windup/windup.git Windup`. See xref:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code] for more info. . Open a command terminal and navigate to the root of the Windup project directory. + -------------- diff --git a/docs/Dev-Concepts-and-Philosophy.adoc b/docs/Dev-Concepts-and-Philosophy.adoc index 00332815b8..1963bd5043 100644 --- a/docs/Dev-Concepts-and-Philosophy.adoc +++ b/docs/Dev-Concepts-and-Philosophy.adoc @@ -1,7 +1,7 @@ [[Dev-Concepts-and-Philosophy]] === Concepts & Philosophy -_TODO - OZIZKA: Can this topic be marked obsolete and be replaced by this one: link:Windup-Processing-Overview[Windup Processing Overview] ?_ +_TODO - OZIZKA: Can this topic be marked obsolete and be replaced by this one: xref:Windup-Processing-Overview[Windup Processing Overview] ?_ Windup is a rule-based tool that allows users to write customized rules based on the needs, constructs, and custom APIs used in their @@ -27,7 +27,7 @@ Java Proxies to the querying). We use this concept heavily. Each ruleset will likely have it's own models. (But you can opt to use Blueprints API if you like). -See also the list of link:Rules-Windup-Models[Windup Models]. +See also the list of xref:Rules-Windup-Models[Windup Models]. ==== Examples of breaking non-trivial workflows into rules diff --git a/docs/Dev-Execute-Windup-Built-from-Source.adoc b/docs/Dev-Execute-Windup-Built-from-Source.adoc index 61621e6228..d7f7ff55fe 100644 --- a/docs/Dev-Execute-Windup-Built-from-Source.adoc +++ b/docs/Dev-Execute-Windup-Built-from-Source.adoc @@ -3,7 +3,7 @@ These instructions are for Windup core developers who plan to build Windup from source to test code updates. -* 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. +* If you are new to the project and not familiar with the procedures to execute Windup, see xref:Execute-Windup[Execute Windup]. It contains complete step-by-step instructions to execute Windup and also provides command line examples. * Experienced users who need a refresher can follow the steps below. + diff --git a/docs/Dev-Internal-API-Features.adoc b/docs/Dev-Internal-API-Features.adoc index 2c8ab67c6b..0db7e4c200 100644 --- a/docs/Dev-Internal-API-Features.adoc +++ b/docs/Dev-Internal-API-Features.adoc @@ -12,7 +12,7 @@ WindupRuleProvider ruleProvider = [source,java] -------- -For more information about the metadata stored in the context, see link:Rules-Metadata[Rules Metadata] +For more information about the metadata stored in the context, see xref:Rules-Metadata[Rules Metadata] ==== In-memory Frames diff --git a/docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc b/docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc index 0a3a06a20f..55c701bbc9 100644 --- a/docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc +++ b/docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc @@ -1,7 +1,7 @@ [[Dev-Submit-Code-Updates-to-the-Windup-Project]] === Submit Code Updates to the Windup Project -To get the Windup Source Code, see link:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code] for instructions. +To get the Windup Source Code, see xref:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code] for instructions. . Open a command terminal and navigate to the root of the Windup project directory. diff --git a/docs/Dev-Troubleshoot-Windup-Issues.adoc b/docs/Dev-Troubleshoot-Windup-Issues.adoc index b7dba9fc31..b6adc9d375 100644 --- a/docs/Dev-Troubleshoot-Windup-Issues.adoc +++ b/docs/Dev-Troubleshoot-Windup-Issues.adoc @@ -5,7 +5,7 @@ Logging is currently broken and will not be fixed any time soon. -See link:Known-Issues[Known Issues] and https://issues.jboss.org/browse/WINDUP-73[WINDUP-73] for the current status. +See xref:Known-Issues[Known Issues] and https://issues.jboss.org/browse/WINDUP-73[WINDUP-73] for the current status. ==== Debugging Exceptions @@ -13,9 +13,9 @@ Exceptions in Surefire reports are broken due to the way Forge wraps exceptions and the way Surefire handles them. You need to debug or rewrap exceptions using `TestUtil.rewrap(ex)`. -See link:Known-Issues[Known Issues] and https://issues.jboss.org/browse/WINDUP-197[WINDUP-197] for the current status.. +See xref:Known-Issues[Known Issues] and https://issues.jboss.org/browse/WINDUP-197[WINDUP-197] for the current status.. ==== Classloading Problems Configuring dependencies in a Forge-based project can be a little tricky. -See link:Dev-Dependencies[Dependencies] for some hints. +See xref:Dev-Dependencies[Dependencies] for some hints. diff --git a/docs/Dev-Windup-Architectural-Components.adoc b/docs/Dev-Windup-Architectural-Components.adoc index 85f6d810e0..0e221f4810 100644 --- a/docs/Dev-Windup-Architectural-Components.adoc +++ b/docs/Dev-Windup-Architectural-Components.adoc @@ -36,7 +36,7 @@ a collection of annotated Java Interfaces. For more information, see: https://github.com/tinkerpop/frames/wiki[TinkerPop Frames]. Windup includes several Frames extensions, which are documented here: -link:Dev-Frames-extensions[Frames Extensions]. +xref:Dev-Frames-extensions[Frames Extensions]. ==== Gremlin diff --git a/docs/Dev-Windup-Project-Information.adoc b/docs/Dev-Windup-Project-Information.adoc index 2c6de6fdda..29e8797e8e 100644 --- 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 Windup link:http://windup.github.io/windup/docs/javadoc/latest/index.html[Javadoc]. +For additional information, refer to the Windup xref:http://windup.github.io/windup/docs/javadoc/latest/index.html[Javadoc]. ==== Website diff --git a/docs/Execute-Windup.adoc b/docs/Execute-Windup.adoc index 6416154009..886d481ccb 100644 --- a/docs/Execute-Windup.adoc +++ b/docs/Execute-Windup.adoc @@ -1,17 +1,22 @@ [[Execute-Windup]] === Execute Windup -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 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 also specify the fully qualified path to a folder that will contain the resulting report information. This path is passed using the `--output` argument on the command line. +* If the folder does not exist, it is created by Windup. +* If the folder exists, you are prompted with the message: + + Overwrite all contents of (anything already in the directory will be deleted)? [y/N] ++ +Choose "y" if you want Windup to delete and recreate the directory. +* If you are confident you want to overwrite the output directory, you can specify `--overwrite` on the command line to automatically delete and recreate the directory. ++ +NOTE: Be careful not to specify a directory that contains important information! . You must also provide a list of the application packages to be evaluated. @@ -21,7 +26,7 @@ This path is passed using the `--output` argument on the command line. ==== Start Windup -For information about the use of WINDUP_HOME in the instructions below, see link:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]. +For information about the use of WINDUP_HOME in the instructions below, see xref:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]. . Open a terminal and navigate to the `WINDUP_HOME/bin` directory @@ -49,6 +54,8 @@ JBoss Windup, version [ 2.0.0-VERSION ] - JBoss, by Red Hat, Inc. [ http://windu [windup-distribution-2.0.0-VERSION]$ --------------------------------------------------------------------------- +==== Run the `windup-migrate-app` Command + . 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: + --------------------------------------------------------------------------- @@ -66,12 +73,12 @@ 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. +*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. +NOTE: If the *OUTPUT_REPORT_DIRECTORY* directory exists, your are prompted to overwrite the contents. If you respond "y", it is deleted and recreated by Windup, so be careful not to specify an output directory that contains important information! + -NOTE: If the *OUTPUT_REPORT_DIRECTORY* directory exists, it is deleted and recreated by Windup, so be careful not to specify a directory that contains important information! +*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. @@ -98,7 +105,7 @@ The following subdirectories in the `OUTPUT_REPORT_DIRECTORY` contain the suppor stats/ index.html -. For details on how to evaluate the report data, see link:Review-the-Report[Review the Report]. +. For details on how to evaluate the report data, see xref:Review-the-Report[Review the Report]. ==== Run Windup in Batch Mode diff --git a/docs/Get-Involved.adoc b/docs/Get-Involved.adoc index 959c3b6a9f..e6bb1eb3ee 100644 --- a/docs/Get-Involved.adoc +++ b/docs/Get-Involved.adoc @@ -10,7 +10,7 @@ To help us make Windup cover most application constructs and server configuratio * Identify application components and problem areas that may be difficult to migrate. ** Write a short description of these problem migration areas. ** Write a brief overview describing how to solve the problem migration areas. -* link:Execute-Windup[Try Windup] on your application. Be sure to link:Report-Issues-with-Windup[report any issues] you encounter. +* xref:Execute-Windup[Try Windup] on your application. Be sure to xref:Report-Issues-with-Windup[report any issues] you encounter. * You can contribute Windup rules. ** Write a Windup rule add-on to automate a migration process. ** Create a test for the new rule. diff --git a/docs/Install-Windup.adoc b/docs/Install-Windup.adoc index 4459320a7d..a9a043d061 100644 --- a/docs/Install-Windup.adoc +++ b/docs/Install-Windup.adoc @@ -1,7 +1,8 @@ [[Install-Windup]] === Install Windup -. Download the latest Windup ZIP distribution from http://repository.jboss.org/nexus/content/groups/public/org/jboss/windup/windup-distribution. This is currently https://repository.jboss.org/nexus/service/local/repositories/releases/content/org/jboss/windup/windup-distribution/2.0.0.Beta7/windup-distribution-2.0.0.Beta7-offline.zip[windup-distribution-2.0.0.Beta7]. +. Download the latest https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=releases&g=org.jboss.windup&a=windup-distribution&v=LATEST&e=zip&c=offline[Windup ZIP distribution]. . Extract the ZIP file in to a directory of your choice. -NOTE: The documentation uses the replaceable value `WINDUP_HOME` to denote the path to the Windup installation. When you encounter this value in the documentation, be sure to replace it with the actual path to your Windup installation. For more information, see link:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]. +NOTE: If you used previous versions of Windup, delete the `${user.home}/.windup/` directory. Otherwise you may see errors like the following when you execute Windup: + _Command: windup-migrate-app was not found_ diff --git a/docs/Known-Issues.adoc b/docs/Known-Issues.adoc index 3cfa4f4006..851a209fa3 100644 --- a/docs/Known-Issues.adoc +++ b/docs/Known-Issues.adoc @@ -1,5 +1,5 @@ [[Known-Issues]] -=== Known Issues +=== Known Windup Issues The following is a list of currently known issues. diff --git a/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc b/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc index d161a3b9a9..eec9cdba12 100644 --- a/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc +++ b/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc @@ -5,8 +5,8 @@ You can create a rule using Java or XML. This topic describes how to create a ru ==== Prerequisites -* You must link:Install-Windup[Install Windup]. -* Be sure you link:Install-and-Configure-Maven[Install and Configure Maven]. +* You must xref:Install-Windup[Install Windup]. +* Be sure you xref:Install-and-Configure-Maven[Install and Configure Maven]. * Before you begin, may want also want to be familiar with the following documentation: ** Windup rules are based on the ocpsoft *rewrite* project. You can find more information about ocpsoft *rewrite* here: http://ocpsoft.org/rewrite/ ** The JavaDoc for the Windup API is located here: http://windup.github.io/windup/docs/javadoc/latest/ @@ -51,7 +51,7 @@ Create a new Maven Java Project. These instructions will refer to the project fo ---- -3. Add a `` section to include Windup, rulesets, and test dependencies required by your rule add-on. Windup is a Forge/Furnace based application and has a modular design, so the dependencies will vary depending on the Windup APIs used by the rule. For more information on Windup dependencies, see link:Dev-Dependencies[Windup Dependencies]. +3. Add a `` section to include Windup, rulesets, and test dependencies required by your rule add-on. Windup is a Forge/Furnace based application and has a modular design, so the dependencies will vary depending on the Windup APIs used by the rule. For more information on Windup dependencies, see xref:Dev-Dependencies[Windup Dependencies]. + The following are examples of some dependencies you may need for your rule add-on. + @@ -190,7 +190,7 @@ public class MyCustomRuleProvider extends WindupRuleProvider return RulePhase.DISCOVERY; } ---- -For more information about rule phases, see link:Rules-Rule-Execution-Lifecycle[Rules Execution Lifecycles]. +For more information about rule phases, see xref:Rules-Rule-Execution-Lifecycle[Rules Execution Lifecycles]. 3. To control the order in which the rule is executed, implement the `getExecuteBefore()` or `getExecuteAfter()` method. + @@ -262,7 +262,7 @@ Windup building elements. The easiest and fastest way to build the rule add-on, install it into the local Maven repository, and install it into Windup as a rule add-on is to use the Windup `addon-build-and-install` command. -* If you have not started Windup, follow the instructions to link:Execute-Windup[Execute Windup]. +* If you have not started Windup, follow the instructions to xref:Execute-Windup[Execute Windup]. * At the Windup console prompt, enter the `addon-build-and-install` command: addon-build-and-install --projectRoot RULE_PROJECT_HOME @@ -283,7 +283,7 @@ You should see the following result: ***SUCCESS*** Windup report created: QUICKSTART_HOME/windup-reports-java/index.html -For more information and examples of how to run Windup, see: link:Execute-Windup[Execute Windup] +For more information and examples of how to run Windup, see: xref:Execute-Windup[Execute Windup] ==== Review the Output Report @@ -296,11 +296,11 @@ TBD. * Models ** https://github.com/tinkerpop/frames/wiki[Frames] -** link:Rules-Windup-Models[Windup Models] +** xref:Rules-Windup-Models[Windup Models] * Rules ** http://ocpsoft.org/rewrite/[OCPSoft Rewrite] ** Conditions, Operations *** Variables ** Inter-rule action -** link:Rules:-Rules-Execution-Lifecycle[Inter-rule dependency] +** xref:Rules:-Rules-Execution-Lifecycle[Inter-rule dependency] *** Short IDs - https://issues.jboss.org/browse/WINDUP-217[WINDUP-216] diff --git a/docs/Rules-Create-a-Basic-XML-Rule.adoc b/docs/Rules-Create-a-Basic-XML-Rule.adoc index ea9cad805a..f0aaf0c13a 100644 --- a/docs/Rules-Create-a-Basic-XML-Rule.adoc +++ b/docs/Rules-Create-a-Basic-XML-Rule.adoc @@ -5,7 +5,7 @@ You can create a rule addon using Java or a rule using XML or Groovy. This topic ==== Prerequisites -* You should have already link:Install-Windup[installed Windup]. +* You should have already xref:Install-Windup[installed Windup]. * Before you begin, you may also want to be familiar with the following documentation: ** Windup rules are based on the ocpsoft *rewrite* project. You can find more information about ocpsoft *rewrite* here: http://ocpsoft.org/rewrite/ ** The JavaDoc for the Windup API is located here: http://windup.github.io/windup/docs/javadoc/latest/ @@ -69,7 +69,7 @@ The following is an example of an XML rule. The XML rule consists of the following level elements: * ****: This element defines this as a Windup rule. -* ****: This element specifies when the ruleset should execute. See link:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecyle] for more information about rule phases. +* ****: This element specifies when the ruleset should execute. See xref:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecyle] for more information about rule phases. * ****: element contains the individual rules. ** ****: This element is a child of the **rules** element. One or more rules can be defined for a ruleset. Each `rule` contains the following elements. *** ****: This element defines the condition to match on. @@ -88,7 +88,7 @@ The XML rule consists of the following level elements: A Windup rule is installed simply by copying the rule to the appropriate Windup folder. Windup scans for rules in the following locations: -WINDUP_HOME/rules/:: This is the Windup folder where you run the Windup executable. See link:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable] for details. +WINDUP_HOME/rules/:: This is the Windup folder where you run the Windup executable. See xref:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable] for details. ${user.home}/.windup/rules/:: This folder is created by Windup the first time you execute Windup. + @@ -99,7 +99,7 @@ For Windows: "\Documents and Settings\USER_NAME\.windup\rules\" -or- "\Users\U ==== Test the XML Rule -NOTE: If you have not started Windup, follow the instructions to link:Execute-Windup[Execute Windup]. +NOTE: If you have not started Windup, follow the instructions to xref:Execute-Windup[Execute Windup]. Test the XML rule against your application file by running the `windup-migrate-app` command in the Windup console prompt. @@ -114,6 +114,6 @@ You should see the following result: -------- ***SUCCESS*** Windup report created: QUICKSTART_HOME/windup-reports-java/index.html -------- -For more information and examples of how to run Windup, see: link:Execute-Windup[Execute Windup] +For more information and examples of how to run Windup, see: xref:Execute-Windup[Execute Windup] diff --git a/docs/Rules-Create-an-Advanced-Ruleset.adoc b/docs/Rules-Create-an-Advanced-Ruleset.adoc index 52f4013d88..052697794c 100644 --- a/docs/Rules-Create-an-Advanced-Ruleset.adoc +++ b/docs/Rules-Create-an-Advanced-Ruleset.adoc @@ -5,7 +5,7 @@ 1. Create the Forge add-on -* link:Rules-Create-a-Basic-Java-based-Rule-Add-on[Create a Basic Java-based Rule Add-on] +* xref:Rules-Create-a-Basic-Java-based-Rule-Add-on[Create a Basic Java-based Rule Add-on] 2. Add the dependencies you need diff --git a/docs/Rules-Development-Guide.asciidoc b/docs/Rules-Development-Guide.asciidoc index 044728f161..3d782ca8b1 100644 --- a/docs/Rules-Development-Guide.asciidoc +++ b/docs/Rules-Development-Guide.asciidoc @@ -62,5 +62,5 @@ If you plan to create Java-based rule addons, you must also do the following. ==== Appendix -* link:Dev-Windup-Architectural-Components[Windup Architectural Components] +* link:Windup-Architectural-Components[Windup Architectural Components] diff --git a/docs/Rules-Java-based-Rule-Structure.adoc b/docs/Rules-Java-based-Rule-Structure.adoc index b44d1bafc7..62a577d262 100644 --- a/docs/Rules-Java-based-Rule-Structure.adoc +++ b/docs/Rules-Java-based-Rule-Structure.adoc @@ -3,7 +3,7 @@ TODO: * Add a how-to for compound rules, nested rules, rules over multiple sources, negative queries (not matched by anything). -// - link:Rules-Story-Points[How to estimate the migration effort with Story +// - xref:Rules-Story-Points[How to estimate the migration effort with Story Points] https://issues.jboss.org/browse/WINDUP-255[WINDUP-255] ==== Windup Rule Provider @@ -12,7 +12,7 @@ Windup rules are based on http://ocpsoft.org/rewrite/[OCPsoft Rewrite], an open Windup rule add-ons must extend the http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/WindupRuleProvider.html[WindupRuleProvider] class. -* If the rule should run in a phase other than the default http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/RulePhase.html#MIGRATION_PHASE[MIGRATION_PHASE], you must implement the http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/WindupRuleProvider.html#getPhase%28%29[getPhase()] method and specify in which Windup lifecycle phase the rule should be executed. For more information about rule phases, see link:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecycle]. +* If the rule should run in a phase other than the default http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/RulePhase.html#MIGRATION_PHASE[MIGRATION_PHASE], you must implement the http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/WindupRuleProvider.html#getPhase%28%29[getPhase()] method and specify in which Windup lifecycle phase the rule should be executed. For more information about rule phases, see xref:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecycle]. * Rules are added using the http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/WindupRuleProvider.html[getConfiguration(GraphContext context)] method. This method is inherited from the http://ocpsoft.org/rewrite/[OCPsoft Rewrite] interface org.ocpsoft.rewrite.config.ConfigurationProvider. Rules are discussed in more detail later. @@ -168,4 +168,4 @@ and not actually used, is `RuleMetadata.CATEGORY`. ==== Available utilities For a list of what key services and constructs can be used in the rule, -see link:Rules-Available-Rules-Utilities[Available Rules Utilities]. \ No newline at end of file +see xref:Rules-Available-Rules-Utilities[Available Rules Utilities]. \ No newline at end of file diff --git a/docs/Rules-Ops-Xml-XsltTransformation.adoc b/docs/Rules-Ops-Xml-XsltTransformation.adoc new file mode 100644 index 0000000000..390f493215 --- /dev/null +++ b/docs/Rules-Ops-Xml-XsltTransformation.adoc @@ -0,0 +1,6 @@ +[[Rules-Ops-Xml-XsltTransformation]] +=== Rules Ops Xml XsltTransformation + +.DRAFT + +TBD? \ No newline at end of file diff --git a/docs/Rules-Rulesets.adoc b/docs/Rules-Rulesets.adoc index a30eece828..b681a84532 100644 --- a/docs/Rules-Rulesets.adoc +++ b/docs/Rules-Rulesets.adoc @@ -9,7 +9,7 @@ Example page for design decisions. Could be generated automatically in the futur A ruleset is a Windup "plug-in" targetting a specific area of migration (e.g. Spring to Java EE 6 migration). Underhood, it is a set of rules, and everything they might need: Operations and Conditions, Report templates (if needed), and static files (e.g. images, XML or CSV files, etc.). A ruleset may also declare metadata, like ruleset ID, dependencies on other rulesets, etc. -link:Ruleset-Java-Basic-Ruleset +xref:Ruleset-Java-Basic-Ruleset Forge add-on (i.e. a `.jar` file). Groovy-based ruleset is a directory with `.windup.groovy` script(s) and its static files, possibly in a `.zip` file. @@ -33,7 +33,7 @@ Besides that, you may use any custom tag. Rulesets distributed with Windup and maintained by the Windup team. -* link:Ruleset-Java-Basic-Ruleset[Java Basic Ruleset] +* xref:Ruleset-Java-Basic-Ruleset[Java Basic Ruleset] * Tags: java, app * Java EE Applications * java-ee, app diff --git a/docs/Rules-Windup-Models.adoc b/docs/Rules-Windup-Models.adoc index b8797d677d..823381ec4d 100644 --- a/docs/Rules-Windup-Models.adoc +++ b/docs/Rules-Windup-Models.adoc @@ -5,7 +5,7 @@ Windup models are the classes extending WindupVertexFrame. They are used to model the data in the graph database to Java objects. This is an overview of the most important models. -The complete and up-to-date list of models is in link:http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/graph/model/WindupVertexFrame.html[Javadoc]. +The complete and up-to-date list of models is in xref:http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/graph/model/WindupVertexFrame.html[Javadoc]. image:images/WindupModels-NbScreenshot.png[Windup Models Graphic] diff --git a/docs/User-Guide.asciidoc b/docs/User-Guide.asciidoc index 61530b20b7..61a48824bb 100644 --- a/docs/User-Guide.asciidoc +++ b/docs/User-Guide.asciidoc @@ -27,4 +27,5 @@ Windup 2.0 to migrate Java applications or other components. * link:Review-the-Windup-Quickstarts[Review the Windup Quickstarts] * link:Known-Issues[Known Issues] * link:Glossary[Glossary of Terms] +* link:Windup-Architectural-Components[Windup Architectural Components] diff --git a/docs/Windup-Architectural-Components.adoc b/docs/Windup-Architectural-Components.adoc new file mode 100644 index 0000000000..2fa4941351 --- /dev/null +++ b/docs/Windup-Architectural-Components.adoc @@ -0,0 +1,69 @@ +[[Windup-Architectural-Components]] +=== Windup Architectural Components + +The following open source software, tools, and APIs are used within +Windup to analyze and provide migration information. If you plan to +contribute source code to the core Windup 2.0 project, you should be +familiar with them. + +==== Forge + +Forge is an open source, extendable, rapid application development tool +for creating Java EE applications using Maven. For more information +about Forge 2, see: http://forge.jboss.org/[JBoss Forge]. + +==== Forge Furnace + +Forge Furnace is a modular runtime container behind Forge that provides +the ability to run Forge addons in an embedded application. For more +information about Forge Furnace, see: +http://forge.jboss.org/document/run-forge-embedded[Run Forge Embedded]. + +==== TinkerPop + +TinkerPop is an open source graph computing framework. For more +information, see: http://www.tinkerpop.com/[TinkerPop]. + +==== Titan + +Titan is a scalable graph database optimized for storing and querying graphs. +For more information, see: http://thinkaurelius.github.io/titan/[Titan Distributed Graph Database] and https://github.com/thinkaurelius/titan/wiki/Beginner%27s-Guide[Titan Beginner's Guide]. + +==== Frames + +Frames represents graph data in the form of interrelated Java Objects or +a collection of annotated Java Interfaces. For more information, see: +https://github.com/tinkerpop/frames/wiki[TinkerPop Frames]. + +Windup includes several Frames extensions, which are documented here: +xref:Dev-Frames-extensions[Frames Extensions]. + +==== Gremlin + +Gremlin is a graph traversal language that allows you to query, analyze, +and manipulate property graphs that implement the Blueprints property +graph data model. For more information, see: +https://github.com/tinkerpop/gremlin/wiki[TinkerPop Gremlin Wiki]. + +==== Blueprints + +Blueprints is an industry standard API used to access graph databases. +For more information about Blueprints, see: +https://github.com/tinkerpop/blueprints/wiki[TinkerPop Blueprints Wiki]. + +==== Pipes + +Pipes is a dataflow framework used to process graph data. It for the +transformation of data from input to output. For more information, see: +https://github.com/tinkerpop/pipes/wiki[Tinkerpop Pipes Wiki]. + +==== Rexster + +Rexster is a graph server that exposes any Blueprints graph through HTTP/REST and a binary protocol called RexPro. Rexster makes extensive use of Blueprints, Pipes, and Gremlin. For more information, see: +https://github.com/tinkerpop/rexster/wiki[TinkerPop Rexster Wiki]. + +==== OCPsoft Rewrite + +OCPsoft Rewrite is an open source routing and URL rewriting solution for +Servlets, Java Web Frameworks, and Java EE. For more information about +Ocpsoft Rewrite, see: http://ocpsoft.org/rewrite/[OCPsoft Rewrite]. diff --git a/docs/Windup-Core-Development-Guide.adoc b/docs/Windup-Core-Development-Guide.adoc index 6a2d6e1f92..dc3b4b2607 100644 --- a/docs/Windup-Core-Development-Guide.adoc +++ b/docs/Windup-Core-Development-Guide.adoc @@ -24,7 +24,7 @@ include::Dev-Submit-Code-Updates-to-the-Windup-Project.adoc[tabsize=4] == Understand the Windup Architecture and Structure -include::Dev-Windup-Architectural-Components.adoc[tabsize=4] +include::Windup-Architectural-Components.adoc[tabsize=4] include::Dev-Windup-Project-Structure.adoc[tabsize=4] == Get Started @@ -32,7 +32,7 @@ include::Install-and-Configure-Maven.adoc[tabsize=4] include::Dev-Get-the-Windup-Source-Code.adoc[tabsize=4] include::Dev-Build-Windup-from-Source.adoc[tabsize=4] include::Dev-Execute-Windup-Built-from-Source.adoc[tabsize=4] -include::Execute-Windup[tabsize=4] +include::Execute-Windup.adoc[tabsize=4] include::Review-the-Report.adoc[tabsize=4] == Rules and Rulesets diff --git a/docs/Windup-Processing-Overview.adoc b/docs/Windup-Processing-Overview.adoc index 4fadff7753..66672e3655 100644 --- a/docs/Windup-Processing-Overview.adoc +++ b/docs/Windup-Processing-Overview.adoc @@ -9,7 +9,7 @@ The following is a high level conceptual overview of what happens within Windup Wnen you run the `windup-migrate-app` command, Windup executes its own core rules to extract files from archives, decompile classes, and analyze the application. In this phase, Windup builds a datamodel, storing component data and relationships in a graph database, which can then be queried and updated as needed by the migration rules and for reporting purposes. -For more information about the graph database components, see link:Dev-Windup-Architectural-Components[Windup Architectural Components]. +For more information about the graph database components, see xref:Windup-Architectural-Components[Windup Architectural Components]. ==== Application Migration @@ -23,7 +23,7 @@ The final step in the process is to pull data from the graph database model to g By default, Windup generates the following reports at the end of the application migration process. The reports are located in the `reports/` subdirectory of the output report path specified when you execute Windup: -* Application Report: This report provides a summary of the total estimated effort, or link:Rules-Rule-Story-Points[story points], that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder. +* Application Report: This report provides a summary of the total estimated effort, or xref:Rules-Rule-Story-Points[story points], that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder. * RuleProvider report: This is a detailed listing of the rule providers that fired when running Windup and whether any errors occurred. * Additional reports are generated that provide detailed line-by-line migration tips for individual files. diff --git a/docs/Windup-Rules-Development-Guide.adoc b/docs/Windup-Rules-Development-Guide.adoc index 11ea29db1e..b9efdb3ae1 100644 --- a/docs/Windup-Rules-Development-Guide.adoc +++ b/docs/Windup-Rules-Development-Guide.adoc @@ -81,7 +81,7 @@ include::Glossary.adoc[tabsize=4] == Appendix -include::Dev-Windup-Architectural-Components.adoc[tabsize=4] +include::Windup-Architectural-Components.adoc[tabsize=4] include::Dev-Dependencies.adoc[tabsize=4] include::Rules-Windup-Models.adoc[tabsize=4] diff --git a/docs/Windup-User-Guide.adoc b/docs/Windup-User-Guide.adoc index b8b3b6bac1..51b2ab5961 100644 --- a/docs/Windup-User-Guide.adoc +++ b/docs/Windup-User-Guide.adoc @@ -36,10 +36,13 @@ include::Review-the-Report.adoc[tabsize=4] include::Review-the-Windup-Quickstarts.adoc[tabsize=4] -include::Known-Issues.adoc[Known Issues] +include::Known-Issues.adoc[tabsize=4] include::Glossary.adoc[tabsize=4] +include::Windup-Architectural-Components.adoc[tabsize=4] + + diff --git a/html/WindupCoreDevelopmentGuide.html b/html/WindupCoreDevelopmentGuide.html index ca9d7efbf6..8f39f04662 100644 --- a/html/WindupCoreDevelopmentGuide.html +++ b/html/WindupCoreDevelopmentGuide.html @@ -431,7 +431,7 @@

Windup Core Development Guide

  • Understand the Windup Architecture and Structure
    • @@ -440,6 +440,7 @@

    Windup Core Development Guide

  • Install and Configure Maven
  • Build Windup from Source
  • Execute Windup (Built from Windup Source)
    • +
  • Execute Windup
  • Review the Report
    • @@ -505,7 +506,7 @@

    Windup Core Development Guide

  • Additional Resources
    • @@ -763,7 +764,7 @@

    How can you help?

  • -

    Try Windup on your application. Be sure to report any issues you encounter.

    +

    Try Windup on your application. Be sure to report any issues you encounter.

  • You can contribute Windup rules.

    @@ -863,7 +864,7 @@

    Documentation

    The Windup documentation is currently located here in the Windup project Wiki.

    -

    For additional information, refer to the Windup Javadoc.

    +

    For additional information, refer to the Windup Javadoc.

    @@ -1096,7 +1097,7 @@
    Tests

    Submit Code Updates to the Windup Project

    -

    To get the Windup Source Code, see Get the Windup Source Code for instructions.

    +

    To get the Windup Source Code, see Get the Windup Source Code for instructions.

      @@ -1202,7 +1203,7 @@

      Submit Code Updates to th

      Understand the Windup Architecture and Structure

      -

      Windup Architectural Components

      +

      Windup Architectural Components

      The following open source software, tools, and APIs are used within Windup to analyze and provide migration information. If you plan to @@ -1249,7 +1250,7 @@

      Frames

      Windup includes several Frames extensions, which are documented here: -Frames Extensions.

      +Frames Extensions.

      @@ -1593,7 +1594,7 @@

      System Requirements to Build Windu

      Maven 3.1.1 or newer

      If you have not yet installed or configured Maven, see -Install and Configure Maven for details.

      +Install and Configure Maven for details.

      If you have installed Maven, you can check the version by typing the @@ -1623,7 +1624,7 @@

      System Requirements to Build Windu

      You must also make sure the IDE embeds Maven 3.1.1 or later. See -Install and Configure Maven for details.

      +Install and Configure Maven for details.

    @@ -1635,10 +1636,10 @@

    Build Windup Using Maven Command

    1. Make sure you have configured Maven as described here: -Install and Configure Maven.

      +Install and Configure Maven.

    2. -

      Check out Windup source code: git clone git@github.com:windup/windup.git Windup. See Get the Windup Source Code for more info.

      +

      Check out Windup source code: git clone git@github.com:windup/windup.git Windup. See Get the Windup Source Code for more info.

    3. Open a command terminal and navigate to the root of the Windup project directory.

      @@ -1773,7 +1774,7 @@

      Execute Windup (Built from Windup
      • -

        If you are new to the project and not familiar with the procedures to execute Windup, see Execute Windup. It contains complete step-by-step instructions to execute Windup and also provides command line examples.

        +

        If you are new to the project and not familiar with the procedures to execute Windup, see Execute Windup. It contains complete step-by-step instructions to execute Windup and also provides command line examples.

      • Experienced users who need a refresher can follow the steps below.

        @@ -1799,8 +1800,279 @@

        Execute Windup (Built from Windup

      +

    +
    +

    Execute Windup

    +
    +

    Prerequisites

    +
    +

    Before you begin, you must gather the following information.

    +
    +
    +
      +
    1. +

      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.

      +
      2. +
    2. +

      You also specify the fully qualified path to a folder that will contain the resulting report information. This path is passed using the --output argument on the command line.

      +
      +
        +
      • +

        If the folder does not exist, it is created by Windup.

        +
        • +
      • +

        If the folder exists, you are prompted with the message:

        +
        +
        +
        Overwrite all contents of <OUTPUT_DIRECTORY> (anything already in the directory will be deleted)? [y/N]
        +
        +
        +
        +

        Choose "y" if you want Windup to delete and recreate the directory.

        +
        +
        • +
      • +

        If you are confident you want to overwrite the output directory, you can specify --overwrite on the command line to automatically delete and recreate the directory.

        +
        + + + + + +
        +
        Note
        +        		 +Be careful not to specify a directory that contains important information! +
        +
        +
        • +
      +
      +
      3. +
    3. +

      You must also provide a list of the application packages to be evaluated.

      +
      +
        +
      • +

        In most cases, you are interested only in evaluating the custom application class packages and not the standard Java EE or 3rd party packages. For example, if the MyCustomApp application uses the package com.mycustomapp, you provide that package using the --packages argument on the command line. It is not necessary to provide the standard Java EE packages, like java.util or javax.ejb.

        +
        • +
      • +

        While you can provide package names for standard Java EE 3rd party software like org.apache, it is usually best not to include them as they should not impact the migration effort.

        +
        • +
      • +

        If you omit the --packages argument, every package in the application is scanned, resulting in very slow performance. It is best to provide the argument with one or more packages.

        +
        • +
      +
      +
      4. +
    +
    +
    +
    +

    Start Windup

    +
    +

    For information about the use of WINDUP_HOME in the instructions below, see About the WINDUP_HOME Variable.

    +
    +
    +
      +
    1. +

      Open a terminal and navigate to the WINDUP_HOME/bin directory

      +
      2. +
    2. +

      Type the following command to start Windup:

      +
      +
      +
      For Linux:    WINDUP_HOME/bin $ ./windup
+For Windows:  C:\WINDUP_HOME\bin> windup
      +
      +
      +
      3. +
    3. +

      You are presented with the following prompt.

      +
      +
      +
      Using Windup at WINDUP_HOME
+
+ _       ___           __
+| |     / (_)___  ____/ /_  ______
+| | /| / / / __ \/ __  / / / / __ \
+| |/ |/ / / / / / /_/ / /_/ / /_/ /
+|__/|__/_/_/ /_/\__,_/\__,_/ .___/
+                          /_/
+
+JBoss Windup, version [ 2.0.0-VERSION ] - JBoss, by Red Hat, Inc. [ http://windup.jboss.org ]
+
+[windup-distribution-2.0.0-VERSION]$
      +
      +
      +
      4. +
    +
    +
    +
    +

    Run the windup-migrate-app Command

    +
    +
      +
    1. +

      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:

      +
      +
      +
      windup-migrate-app --input INPUT_ARCHIVE_OR_FOLDER --output OUTPUT_REPORT_DIRECTORY --packages PACKAGE_1 PACKAGE_2 PACKAGE_N
      +
      +
      +
      +

      To run Windup against application source code, you must add the --sourceMode true argument:

      +
      +
      +
      +
      windup-migrate-app --sourceMode true --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.

      +
      +
      + + + + + +
      +
      Note
      +      		 +If the OUTPUT_REPORT_DIRECTORY directory exists, your are prompted to overwrite the contents. If you respond "y", it is deleted and recreated by Windup, so be careful not to specify an output directory that contains important information! +
      +
      +
      +

      PACKAGE_1, PACKAGE_2, PACKAGE_N are the packages to be evaluated by Windup.

      +
      +
      +

      See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

      +
      +
      2. +
    2. +

      You should see the following result upon completion of the command:

      +
      +
      +
      ***SUCCESS*** Windup execution successful!
      +
      +
      +
      3. +
    3. +

      To exit Windup, type:

      +
      +
      +
      exit
      +
      +
      +
      4. +
    4. +

      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
      +
      +
      +
      5. +
    5. +

      For details on how to evaluate the report data, see Review the Report.

      +
      6. +
    +
    +
    +
    +

    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.

    +
    +
    +
      +
    1. +

      Open a terminal and navigate to the WINDUP_HOME directory.

      +
      2. +
    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"
      +
      +
      +
      3. +
    +
    +
    +
    +

    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

    +
    +

    The following Windup command examples report against applications located in the Windup source test-files directory.

    +
    +
    +
    Source Code Example
    -

    Unresolved directive in Windup-Core-Development-Guide.adoc - include::Execute-Windup[tabsize=4]

    +

    The following command runs against the 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 --sourceMode true --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 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
    +
    +
    +
    +
    +
    Windup Batch Example
    +
    +

    The following Windup batch command runs against the 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 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.

    +
    +
    @@ -2016,7 +2288,7 @@

    Discovery Phase

    Wnen you run the windup-migrate-app command, Windup executes its own core rules to extract files from archives, decompile classes, and analyze the application. In this phase, Windup builds a datamodel, storing component data and relationships in a graph database, which can then be queried and updated as needed by the migration rules and for reporting purposes.

    -

    For more information about the graph database components, see Windup Architectural Components.

    +

    For more information about the graph database components, see Windup Architectural Components.

    @@ -2039,7 +2311,7 @@

    Generate Finding
    • -

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

      +

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

    • RuleProvider report: This is a detailed listing of the rule providers that fired when running Windup and whether any errors occurred.

      @@ -2265,7 +2537,7 @@

      Windup Rule Provider

    @@ -2587,14 +2859,14 @@

    Create a Basic Java-based R

    You can create a rule using Java or XML. This topic describes how to create a rule add-on using Java.

    -

    Prerequisites

    +

    Prerequisites

  • -

    Add a <dependencies> section to include Windup, rulesets, and test dependencies required by your rule add-on. Windup is a Forge/Furnace based application and has a modular design, so the dependencies will vary depending on the Windup APIs used by the rule. For more information on Windup dependencies, see Windup Dependencies.

    +

    Add a <dependencies> section to include Windup, rulesets, and test dependencies required by your rule add-on. Windup is a Forge/Furnace based application and has a modular design, so the dependencies will vary depending on the Windup APIs used by the rule. For more information on Windup dependencies, see Windup Dependencies.

    The following are examples of some dependencies you may need for your rule add-on.

    @@ -2815,7 +3087,7 @@
    Create the Java RuleProvider
    -

    For more information about rule phases, see Rules Execution Lifecycles.

    +

    For more information about rule phases, see Rules Execution Lifecycles.

  • @@ -2910,7 +3182,7 @@

    Install the Java-based Rule Add-on<
    • -

      If you have not started Windup, follow the instructions to Execute Windup.

      +

      If you have not started Windup, follow the instructions to Execute Windup.

    • At the Windup console prompt, enter the addon-build-and-install command:

      @@ -2953,7 +3225,7 @@

      Test the Java-based Rule Add-on

    -

    For more information and examples of how to run Windup, see: Execute Windup

    +

    For more information and examples of how to run Windup, see: Execute Windup

    @@ -2984,7 +3256,7 @@

    Review the Output Report

    Frames

  • -

    Windup Models

    +

    Windup Models

    • @@ -3010,7 +3282,7 @@

    Review the Output Report

    Inter-rule action

  • -

    Inter-rule dependency

    +

    Inter-rule dependency

    -

    Prerequisites

    +

    Prerequisites

    • -

      You should have already installed Windup.

      +

      You should have already installed Windup.

    • Before you begin, you may also want to be familiar with the following documentation:

      @@ -3169,7 +3441,7 @@
      Create the XML Rule

      <ruleset>: This element defines this as a Windup rule.

    • -

      <phase>: This element specifies when the ruleset should execute. See Rule Execution Lifecyle for more information about rule phases.

      +

      <phase>: This element specifies when the ruleset should execute. See Rule Execution Lifecyle for more information about rule phases.

    • <rules>: element contains the individual rules.

      @@ -3244,7 +3516,7 @@

      Add the Rule to Windup

      WINDUP_HOME/rules/
      -

      This is the Windup folder where you run the Windup executable. See About the WINDUP_HOME Variable for details.

      +

      This is the Windup folder where you run the Windup executable. See About the WINDUP_HOME Variable for details.

      ${user.home}/.windup/rules/
      @@ -3268,7 +3540,7 @@

      Test the XML Rule

      Note
      -If you have not started Windup, follow the instructions to Execute Windup. +If you have not started Windup, follow the instructions to Execute Windup. @@ -3293,7 +3565,7 @@

      Test the XML Rule

    -

    For more information and examples of how to run Windup, see: Execute Windup

    +

    For more information and examples of how to run Windup, see: Execute Windup

    @@ -3853,7 +4125,7 @@

    Find the RuleProvider that
    -

    For more information about the metadata stored in the context, see Rules Metadata

    +

    For more information about the metadata stored in the context, see Rules Metadata

    @@ -4208,7 +4480,7 @@

    Modify Graph Data

    Concepts & Philosophy

    -

    TODO - OZIZKA: Can this topic be marked obsolete and be replaced by this one: Windup Processing Overview ?

    +

    TODO - OZIZKA: Can this topic be marked obsolete and be replaced by this one: Windup Processing Overview ?

    Windup is a rule-based tool that allows users to write customized rules @@ -4240,7 +4512,7 @@

    Graph database and Models (Frames)

    -

    See also the list of Windup Models.

    +

    See also the list of Windup Models.

    @@ -4304,7 +4576,7 @@

    What is a Ruleset?

    A ruleset may also declare metadata, like ruleset ID, dependencies on other rulesets, etc.

    -

    link:Ruleset-Java-Basic-Ruleset +

    xref:Ruleset-Java-Basic-Ruleset Forge add-on (i.e. a .jar file).

    @@ -4347,7 +4619,7 @@
    Core rulesets

    This is an overview of the most important models. -The complete and up-to-date list of models is in Javadoc.

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

    Windup Models Graphic

    @@ -5120,7 +5392,7 @@

    Logging

    Logging is currently broken and will not be fixed any time soon.

    -

    See Known Issues and WINDUP-73 for the current status.

    +

    See Known Issues and WINDUP-73 for the current status.

    @@ -5131,14 +5403,14 @@

    Debugging Exceptions

    debug or rewrap exceptions using TestUtil.rewrap(ex).

    -

    See Known Issues and WINDUP-197 for the current status..

    +

    See Known Issues and WINDUP-197 for the current status..

    Classloading Problems

    Configuring dependencies in a Forge-based project can be a little tricky. -See Dependencies for some hints.

    +See Dependencies for some hints.

    @@ -5207,33 +5479,33 @@

    Contributor Guidelines

    At the beginning of each new Wiki page, add an anchor with the exact page name, including the dashes. This generates the correct anchors that are needed when the pages are combined into a book.

    -
    [[Dev-Build-Windup-from-Source]]
-=== Build Windup from Source
    +
    [[Page-Name]]
+=== Page Name

  • Wiki generates anchors using dashes for spaces. AsciiDoctor generates a leading underscore and underscores for spaces.When referring to another section within the same page, do not use the [section-title-anchor] syntax. Instead, create an anchor and use the 'xref:' syntax to provide the link. Replace spaces in the section title with dashes.

    +
    +
      +
    • +

      Create the anchor at the top of the section using double brackets to force the generation of dashes instead of underscores.

      -
      Create the anchor at the top of the section using double brackets to force the generation of dashes instead of underscores.
      -
      -
      -
      -
      -
      [[windup-command-examples]]
-==== Windup Command Examples
      +
      [[section-header]]
+==== Section Header
      +
      • +
    • +

      Then use the xref to create the link.

      -
      Then use the `xref` to create the link.
      -
      +
      See xref:section-header[Section Header] for more information.
      -
      -
      -
      See xref:windup-command-examples[Windup Command Examples] for more information.
      +
      • +
    • @@ -5548,7 +5820,7 @@

    Fork and Clone the GitHub Project
    -

    Known Issues

    +

    Known Windup Issues

    The following is a list of currently known issues.

    @@ -5677,7 +5949,7 @@

    Reporting Terms

    diff --git a/html/WindupRulesDevelopmentGuide.html b/html/WindupRulesDevelopmentGuide.html index 1f32647ef6..9a38d28276 100644 --- a/html/WindupRulesDevelopmentGuide.html +++ b/html/WindupRulesDevelopmentGuide.html @@ -476,13 +476,13 @@

    Windup Rules Development Guide

  • Appendix @@ -726,7 +726,7 @@

    Discovery Phase

    Wnen you run the windup-migrate-app command, Windup executes its own core rules to extract files from archives, decompile classes, and analyze the application. In this phase, Windup builds a datamodel, storing component data and relationships in a graph database, which can then be queried and updated as needed by the migration rules and for reporting purposes.

    -

    For more information about the graph database components, see Windup Architectural Components.

    +

    For more information about the graph database components, see Windup Architectural Components.

    @@ -749,7 +749,7 @@

    Generate Finding
    • -

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

      +

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

    • RuleProvider report: This is a detailed listing of the rule providers that fired when running Windup and whether any errors occurred.

      @@ -793,7 +793,7 @@

      How can you help?

  • -

    Try Windup on your application. Be sure to report any issues you encounter.

    +

    Try Windup on your application. Be sure to report any issues you encounter.

  • You can contribute Windup rules.

    @@ -990,7 +990,7 @@

    Install Windup

    1. -

      Download the latest Windup ZIP distribution from http://repository.jboss.org/nexus/content/groups/public/org/jboss/windup/windup-distribution. This is currently windup-distribution-2.0.0.Beta7.

      +

      Download the latest Windup ZIP distribution.

    2. Extract the ZIP file in to a directory of your choice.

      @@ -1004,7 +1004,8 @@

      Install Windup

      Note
      -The documentation uses the replaceable value WINDUP_HOME to denote the path to the Windup installation. When you encounter this value in the documentation, be sure to replace it with the actual path to your Windup installation. For more information, see About the WINDUP_HOME Variable. +If you used previous versions of Windup, delete the ${user.home}/.windup/ directory. Otherwise you may see errors like the following when you execute Windup: + Command: windup-migrate-app was not found @@ -1012,6 +1013,36 @@

      Install Windup

    Execute Windup

    +
    +

    Prerequisites

    +
    +

    Before you begin, you must gather the following information.

    +
    +
    +
      +
    1. +

      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.

      +
      2. +
    2. +

      You also specify the fully qualified path to a folder that will contain the resulting report information. This path is passed using the --output argument on the command line.

      +
      +
        +
      • +

        If the folder does not exist, it is created by Windup.

        +
        • +
      • +

        If the folder exists, you are prompted with the message:

        +
        +
        +
        Overwrite all contents of <OUTPUT_DIRECTORY> (anything already in the directory will be deleted)? [y/N]
        +
        +
        +
        +

        Choose "y" if you want Windup to delete and recreate the directory.

        +
        +
        • +
      • +

        If you are confident you want to overwrite the output directory, you can specify --overwrite on the command line to automatically delete and recreate the directory.

        @@ -1019,25 +1050,14 @@

        Execute Windup

        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 +Be careful not to specify a directory that contains important information!
        -
        -

        Prerequisites

        -
        -

        Before you begin, you must gather the following information.

        -
        -
        -
          -
        1. -

          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.

          2. -
        2. -

          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.

          +
      +

    3. You must also provide a list of the application packages to be evaluated.

      @@ -1061,7 +1081,7 @@

      Prerequisites

      Start Windup

      -

      For information about the use of WINDUP_HOME in the instructions below, see About the WINDUP_HOME Variable.

      +

      For information about the use of WINDUP_HOME in the instructions below, see About the WINDUP_HOME Variable.

        @@ -1096,6 +1116,13 @@

        Start Windup

      4. +
    +
    +
    +
    +

    Run the windup-migrate-app Command

    +
    +

    1. 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:

      @@ -1120,9 +1147,6 @@

      Start Windup

      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.

      -
      @@ -1130,12 +1154,15 @@

      Start Windup

      Note
      -If the OUTPUT_REPORT_DIRECTORY directory exists, it is deleted and recreated by Windup, so be careful not to specify a directory that contains important information! +If the OUTPUT_REPORT_DIRECTORY directory exists, your are prompted to overwrite the contents. If you respond "y", it is deleted and recreated by Windup, so be careful not to specify an output directory that contains important information!
      +

      PACKAGE_1, PACKAGE_2, PACKAGE_N are the packages to be evaluated by Windup.

      +
      +

      See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

      2. @@ -1170,7 +1197,7 @@

      Start Windup

  • -

    For details on how to evaluate the report data, see Review the Report.

    +

    For details on how to evaluate the report data, see Review the Report.

    • @@ -1605,7 +1632,7 @@

    Discovery Phase

    Wnen you run the windup-migrate-app command, Windup executes its own core rules to extract files from archives, decompile classes, and analyze the application. In this phase, Windup builds a datamodel, storing component data and relationships in a graph database, which can then be queried and updated as needed by the migration rules and for reporting purposes.

    -

    For more information about the graph database components, see Windup Architectural Components.

    +

    For more information about the graph database components, see Windup Architectural Components.

    @@ -1628,7 +1655,7 @@

    Generate Findi
    • -

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

      +

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

    • RuleProvider report: This is a detailed listing of the rule providers that fired when running Windup and whether any errors occurred.

      @@ -1854,7 +1881,7 @@

      Windup Rule Provider

    @@ -2180,10 +2207,10 @@

    Prerequisites

  • -

    Add a <dependencies> section to include Windup, rulesets, and test dependencies required by your rule add-on. Windup is a Forge/Furnace based application and has a modular design, so the dependencies will vary depending on the Windup APIs used by the rule. For more information on Windup dependencies, see Windup Dependencies.

    +

    Add a <dependencies> section to include Windup, rulesets, and test dependencies required by your rule add-on. Windup is a Forge/Furnace based application and has a modular design, so the dependencies will vary depending on the Windup APIs used by the rule. For more information on Windup dependencies, see Windup Dependencies.

    The following are examples of some dependencies you may need for your rule add-on.

    @@ -2404,7 +2431,7 @@
    Create the Java RuleProvider
    • -

    For more information about rule phases, see Rules Execution Lifecycles.

    +

    For more information about rule phases, see Rules Execution Lifecycles.

  • @@ -2499,7 +2526,7 @@

    Install the Java-based Rule Add-on<
    • -

      If you have not started Windup, follow the instructions to Execute Windup.

      +

      If you have not started Windup, follow the instructions to Execute Windup.

    • At the Windup console prompt, enter the addon-build-and-install command:

      @@ -2542,7 +2569,7 @@

      Test the Java-based Rule Add-on

    -

    For more information and examples of how to run Windup, see: Execute Windup

    +

    For more information and examples of how to run Windup, see: Execute Windup

    @@ -2573,7 +2600,7 @@

    Review the Output Report

    Frames

  • -

    Windup Models

    +

    Windup Models

    • @@ -2599,7 +2626,7 @@

    Review the Output Report

    Inter-rule action

  • -

    Inter-rule dependency

    +

    Inter-rule dependency

    • @@ -2622,7 +2649,7 @@

      Review the Output Report

      @@ -2660,7 +2687,7 @@

      Prerequisites

      • -

        You should have already installed Windup.

        +

        You should have already installed Windup.

      • Before you begin, you may also want to be familiar with the following documentation:

        @@ -2758,7 +2785,7 @@
        Create the XML Rule

        <ruleset>: This element defines this as a Windup rule.

      • -

        <phase>: This element specifies when the ruleset should execute. See Rule Execution Lifecyle for more information about rule phases.

        +

        <phase>: This element specifies when the ruleset should execute. See Rule Execution Lifecyle for more information about rule phases.

      • <rules>: element contains the individual rules.

        @@ -2833,7 +2860,7 @@

        Add the Rule to Windup

        WINDUP_HOME/rules/
        -

        This is the Windup folder where you run the Windup executable. See About the WINDUP_HOME Variable for details.

        +

        This is the Windup folder where you run the Windup executable. See About the WINDUP_HOME Variable for details.

        ${user.home}/.windup/rules/
        @@ -2857,7 +2884,7 @@

        Test the XML Rule

        Note
        -If you have not started Windup, follow the instructions to Execute Windup. +If you have not started Windup, follow the instructions to Execute Windup. @@ -2882,7 +2909,7 @@

        Test the XML Rule

    -

    For more information and examples of how to run Windup, see: Execute Windup

    +

    For more information and examples of how to run Windup, see: Execute Windup

    @@ -3275,7 +3302,7 @@

    Logging

    Logging is currently broken and will not be fixed any time soon.

    -

    See Known Issues and WINDUP-73 for the current status.

    +

    See Known Issues and WINDUP-73 for the current status.

    @@ -3286,14 +3313,14 @@

    Debugging Exceptions

    debug or rewrap exceptions using TestUtil.rewrap(ex).

    -

    See Known Issues and WINDUP-197 for the current status..

    +

    See Known Issues and WINDUP-197 for the current status..

    Classloading Problems

    Configuring dependencies in a Forge-based project can be a little tricky. -See Dependencies for some hints.

    +See Dependencies for some hints.

    @@ -3492,7 +3519,7 @@

    Fork and Clone the GitHub Project<
    -

    Known Issues

    +

    Known Windup Issues

    The following is a list of currently known issues.

    @@ -3622,7 +3649,7 @@

    Reporting Terms

    Appendix

    -

    Windup Architectural Components

    +

    Windup Architectural Components

    The following open source software, tools, and APIs are used within Windup to analyze and provide migration information. If you plan to @@ -3669,7 +3696,7 @@

    Frames

    Windup includes several Frames extensions, which are documented here: -Frames Extensions.

    +Frames Extensions.

    @@ -3873,7 +3900,7 @@

    Windup Models

    This is an overview of the most important models. -The complete and up-to-date list of models is in Javadoc.

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

    Windup Models Graphic

    @@ -3913,7 +3940,7 @@

    Custom Models (coming from Addons) diff --git a/html/WindupUserGuide.html b/html/WindupUserGuide.html index 11f3b4304d..384fad550d 100644 --- a/html/WindupUserGuide.html +++ b/html/WindupUserGuide.html @@ -435,8 +435,9 @@

    Windup User Guide

  • Additional Resources
    • @@ -678,7 +679,7 @@

    Discovery Phase

    Wnen you run the windup-migrate-app command, Windup executes its own core rules to extract files from archives, decompile classes, and analyze the application. In this phase, Windup builds a datamodel, storing component data and relationships in a graph database, which can then be queried and updated as needed by the migration rules and for reporting purposes.

    -

    For more information about the graph database components, see Windup Architectural Components.

    +

    For more information about the graph database components, see Windup Architectural Components.

    @@ -701,7 +702,7 @@

    Generate Finding
    • -

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

      +

      Application Report: This report provides a summary of the total estimated effort, or story points, that are required for the migration. It also provides a detailed list of issues and suggested changes, broken down by archive or folder.

    • RuleProvider report: This is a detailed listing of the rule providers that fired when running Windup and whether any errors occurred.

      @@ -745,7 +746,7 @@

      How can you help?

  • -

    Try Windup on your application. Be sure to report any issues you encounter.

    +

    Try Windup on your application. Be sure to report any issues you encounter.

  • You can contribute Windup rules.

    @@ -942,7 +943,7 @@

    Install Windup

    1. -

      Download the latest Windup ZIP distribution from http://repository.jboss.org/nexus/content/groups/public/org/jboss/windup/windup-distribution. This is currently windup-distribution-2.0.0.Beta7.

      +

      Download the latest Windup ZIP distribution.

    2. Extract the ZIP file in to a directory of your choice.

      @@ -956,7 +957,8 @@

      Install Windup

      Note
      -The documentation uses the replaceable value WINDUP_HOME to denote the path to the Windup installation. When you encounter this value in the documentation, be sure to replace it with the actual path to your Windup installation. For more information, see About the WINDUP_HOME Variable. +If you used previous versions of Windup, delete the ${user.home}/.windup/ directory. Otherwise you may see errors like the following when you execute Windup: + Command: windup-migrate-app was not found @@ -964,6 +966,36 @@

      Install Windup

    Execute Windup

    +
    +

    Prerequisites

    +
    +

    Before you begin, you must gather the following information.

    +
    +
    +
      +
    1. +

      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.

      +
      2. +
    2. +

      You also specify the fully qualified path to a folder that will contain the resulting report information. This path is passed using the --output argument on the command line.

      +
      +
        +
      • +

        If the folder does not exist, it is created by Windup.

        +
        • +
      • +

        If the folder exists, you are prompted with the message:

        +
        +
        +
        Overwrite all contents of <OUTPUT_DIRECTORY> (anything already in the directory will be deleted)? [y/N]
        +
        +
        +
        +

        Choose "y" if you want Windup to delete and recreate the directory.

        +
        +
        • +
      • +

        If you are confident you want to overwrite the output directory, you can specify --overwrite on the command line to automatically delete and recreate the directory.

        @@ -971,25 +1003,14 @@

        Execute Windup

        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 +Be careful not to specify a directory that contains important information!
        -
        -

        Prerequisites

        -
        -

        Before you begin, you must gather the following information.

        -
        -
        -
          -
        1. -

          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.

          2. -
        2. -

          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.

          +
      +

    3. You must also provide a list of the application packages to be evaluated.

      @@ -1013,7 +1034,7 @@

      Prerequisites

      Start Windup

      -

      For information about the use of WINDUP_HOME in the instructions below, see About the WINDUP_HOME Variable.

      +

      For information about the use of WINDUP_HOME in the instructions below, see About the WINDUP_HOME Variable.

        @@ -1048,6 +1069,13 @@

        Start Windup

      4. +
    +
    +
    +
    +

    Run the windup-migrate-app Command

    +
    +

    1. 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:

      @@ -1072,9 +1100,6 @@

      Start Windup

      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.

      -
      @@ -1082,12 +1107,15 @@

      Start Windup

      Note
      -If the OUTPUT_REPORT_DIRECTORY directory exists, it is deleted and recreated by Windup, so be careful not to specify a directory that contains important information! +If the OUTPUT_REPORT_DIRECTORY directory exists, your are prompted to overwrite the contents. If you respond "y", it is deleted and recreated by Windup, so be careful not to specify an output directory that contains important information!
      +

      PACKAGE_1, PACKAGE_2, PACKAGE_N are the packages to be evaluated by Windup.

      +
      +

      See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

      2. @@ -1122,7 +1150,7 @@

      Start Windup

  • -

    For details on how to evaluate the report data, see Review the Report.

    +

    For details on how to evaluate the report data, see Review the Report.

    • @@ -1473,7 +1501,7 @@

    Fork and Clone the GitHub Project
    -

    Known Issues

    +

    Known Windup Issues

    The following is a list of currently known issues.

    @@ -1597,12 +1625,104 @@

    Reporting Terms

    +
    +

    Windup Architectural Components

    +
    +

    The following open source software, tools, and APIs are used within +Windup to analyze and provide migration information. If you plan to +contribute source code to the core Windup 2.0 project, you should be +familiar with them.

    +
    +
    +

    Forge

    +
    +

    Forge is an open source, extendable, rapid application development tool +for creating Java EE applications using Maven. For more information +about Forge 2, see: JBoss Forge.

    +
    +
    +
    +

    Forge Furnace

    +
    +

    Forge Furnace is a modular runtime container behind Forge that provides +the ability to run Forge addons in an embedded application. For more +information about Forge Furnace, see: +Run Forge Embedded.

    +
    +
    +
    +

    TinkerPop

    +
    +

    TinkerPop is an open source graph computing framework. For more +information, see: TinkerPop.

    +
    +
    +
    +

    Titan

    +
    +

    Titan is a scalable graph database optimized for storing and querying graphs. +For more information, see: Titan Distributed Graph Database and Titan Beginner’s Guide.

    +
    +
    +
    +

    Frames

    +
    +

    Frames represents graph data in the form of interrelated Java Objects or +a collection of annotated Java Interfaces. For more information, see: +TinkerPop Frames.

    +
    +
    +

    Windup includes several Frames extensions, which are documented here: +Frames Extensions.

    +
    +
    +
    +

    Gremlin

    +
    +

    Gremlin is a graph traversal language that allows you to query, analyze, +and manipulate property graphs that implement the Blueprints property +graph data model. For more information, see: +TinkerPop Gremlin Wiki.

    +
    +
    +
    +

    Blueprints

    +
    +

    Blueprints is an industry standard API used to access graph databases. +For more information about Blueprints, see: +TinkerPop Blueprints Wiki.

    +
    +
    +
    +

    Pipes

    +
    +

    Pipes is a dataflow framework used to process graph data. It for the +transformation of data from input to output. For more information, see: +Tinkerpop Pipes Wiki.

    +
    +
    +
    +

    Rexster

    +
    +

    Rexster is a graph server that exposes any Blueprints graph through HTTP/REST and a binary protocol called RexPro. Rexster makes extensive use of Blueprints, Pipes, and Gremlin. For more information, see: +TinkerPop Rexster Wiki.

    +
    +
    +
    +

    OCPsoft Rewrite

    +
    +

    OCPsoft Rewrite is an open source routing and URL rewriting solution for +Servlets, Java Web Frameworks, and Java EE. For more information about +Ocpsoft Rewrite, see: OCPsoft Rewrite.

    +
    +
    +
    diff --git a/scripts/createLinksScripts.sh b/scripts/createLinksScripts.sh new file mode 100644 index 0000000000..77288a3ff9 --- /dev/null +++ b/scripts/createLinksScripts.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +## + +#cd scripts + +find . -name '*.txt' -print | xargs sed -i 's/=/#/g' + +## The following don't work +find . -name '*.txt' -print | xargs sed -i 's/include::/grep \'link:[A-Z]\' `find . -name \'/g' +find . -name '*.txt' -print | xargs sed -i 's/[tabsize#4]/\'`/g' + diff --git a/scripts/pagelinksCoreDevelopmentGuide.sh b/scripts/pagelinksCoreDevelopmentGuide.sh new file mode 100755 index 0000000000..34a5fe3d99 --- /dev/null +++ b/scripts/pagelinksCoreDevelopmentGuide.sh @@ -0,0 +1,98 @@ +#!/bin/bash + +# Windup Core Development Guide + +pwd + +## Overview + +grep 'link:[A-Z]' `find . -name 'What-is-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Features-of-Windup-2.0.adoc'` +grep 'link:[A-Z]' `find . -name 'Get-Involved.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Windup-Project-Information.adoc'` +grep 'link:[A-Z]' `find . -name 'Report-Issues-with-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'About-the-WINDUP_HOME-Variable.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Development-Guidelines.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Submit-Code-Updates-to-the-Windup-Project.adoc'` +grep 'link:[A-Z]' `find . -name 'Windup-Architectural-Components.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Windup-Project-Structure.adoc'` + +## Get Started + +grep 'link:[A-Z]' `find . -name 'Install-and-Configure-Maven.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Get-the-Windup-Source-Code.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Build-Windup-from-Source.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Execute-Windup-Built-from-Source.adoc'` +grep 'link:[A-Z]' `find . -name 'Execute-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Review-the-Report.adoc'` + +## Rules and Rulesets + +grep 'link:[A-Z]' `find . -name 'Windup-Processing-Overview.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rule-Execution-Lifecycle.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rule-Story-Points.adoc'` + +## Create and Test Java Rule Add-ons + +grep 'link:[A-Z]' `find . -name 'Rules-Java-based-Rule-Structure.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Basic-Rule-Execution-Flow-Patterns.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Create-an-Advanced-Ruleset.adoc'` + +## Create and Test XML Rules + +grep 'link:[A-Z]' `find . -name 'Rules-Create-a-Basic-XML-Rule.adoc'` + +## Core Developer topics + +grep 'link:[A-Z]' `find . -name 'Dev-Windup-Bootstrap.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Classloading-Notes.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Connect-to-the-Graph-via-Rexster.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Decompiling.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Dependencies.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Frames-Extensions.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Internal-API-Features.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Logging.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Variables-Stack.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Port-WindRide-Functionality-to-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Git-Rebasing.adoc'` + +## Rules topics + +grep 'link:[A-Z]' `find . -name 'Rules-Available-Rules-Utilities.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Concepts-and-Philosophy.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Creating-Rule-Operations.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rulesets.adoc'` +grep 'link:[A-Z]' `find . -name 'Ruleset-Java-Basic-Ruleset.adoc'` +grep 'link:[A-Z]' `find . -name 'Ruleset-Java-Classifications-and-Inline-Hints.adoc'` +grep 'link:[A-Z]' `find . -name 'Ruleset-Java-EE-Apps.adoc'` +grep 'link:[A-Z]' `find . -name 'Ruleset-Java-EE-Servers.adoc'` +grep 'link:[A-Z]' `find . -name 'Ruleset-Reporting.adoc'` +grep 'link:[A-Z]' `find . -name 'Ruleset-XML.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Windup-Models.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Create-Java-Queries.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rules-Metadata.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rules-Operations.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Ops-Reporting-Classification.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Ops-Reporting-Hint.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Ops-Reporting-TypeReference.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Ops-Xml-XsltTrasformation.adoc'` + +## Debugging and Troubleshooting + +grep 'link:[A-Z]' `find . -name 'Dev-Debugging-and-Profiling.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Troubleshoot-Windup-Issues.adoc'` + +#### Wiki and Product Documentation + +grep 'link:[A-Z]' `find . -name 'About-the-Windup-Wiki.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Add-Images-to-the-Windup-Wiki.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Create-Windup-JavaDoc.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Windup-Documentation-Process.adoc'` + +## Additional Resources + +grep 'link:[A-Z]' `find . -name 'Review-the-Windup-Quickstarts.adoc'` +grep 'link:[A-Z]' `find . -name 'Known-Issues.adoc'` +grep 'link:[A-Z]' `find . -name 'Glossary.adoc'` + diff --git a/scripts/pagelinksCoreDevelopmentGuide.txt b/scripts/pagelinksCoreDevelopmentGuide.txt new file mode 100644 index 0000000000..dc3b4b2607 --- /dev/null +++ b/scripts/pagelinksCoreDevelopmentGuide.txt @@ -0,0 +1,105 @@ += Windup Core Development Guide + +:toc: +:toclevels: 4 + +== Overview + +This guide is for developers who plan to contribute source code updates +or core rule add-ons to the Windup 2.0 project. + +NOTE: This is a very rough first draft! + +include::What-is-Windup.adoc[tabsize=4] +include::Features-of-Windup-2.0.adoc[tabsize=4] +include::Get-Involved.adoc[tabsize=4] +include::Dev-Windup-Project-Information.adoc[tabsize=4] +include::Report-Issues-with-Windup.adoc[tabsize=4] +include::About-the-WINDUP_HOME-Variable.adoc[tabsize=4] + +== Developer Contributing Information + +include::Dev-Development-Guidelines.adoc[tabsize=4] +include::Dev-Submit-Code-Updates-to-the-Windup-Project.adoc[tabsize=4] + +== Understand the Windup Architecture and Structure + +include::Windup-Architectural-Components.adoc[tabsize=4] +include::Dev-Windup-Project-Structure.adoc[tabsize=4] + +== Get Started +include::Install-and-Configure-Maven.adoc[tabsize=4] +include::Dev-Get-the-Windup-Source-Code.adoc[tabsize=4] +include::Dev-Build-Windup-from-Source.adoc[tabsize=4] +include::Dev-Execute-Windup-Built-from-Source.adoc[tabsize=4] +include::Execute-Windup.adoc[tabsize=4] +include::Review-the-Report.adoc[tabsize=4] + +== Rules and Rulesets +include::Windup-Processing-Overview.adoc[tabsize=4] +include::Rules-Rule-Execution-Lifecycle.adoc[tabsize=4] +include::Rules-Rule-Story-Points.adoc[tabsize=4] + +== Create and Test Java Rule Add-ons +include::Rules-Java-based-Rule-Structure.adoc[tabsize=4] +include::Rules-Basic-Rule-Execution-Flow-Patterns.adoc[tabsize=4] +include::Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc[tabsize=4] +include::Rules-Create-an-Advanced-Ruleset.adoc[tabsize=4] + +== Create and Test XML Rules + +include::Rules-Create-a-Basic-XML-Rule.adoc[tabsize=4] + +== Core Developer topics + +include::Dev-Windup-Bootstrap.adoc[tabsize=4] +include::Dev-Classloading-Notes.adoc[tabsize=4] +include::Dev-Connect-to-the-Graph-via-Rexster.adoc[tabsize=4] +include::Dev-Decompiling.adoc[tabsize=4] +include::Dev-Dependencies.adoc[tabsize=4] +include::Dev-Frames-Extensions.adoc[tabsize=4] +include::Dev-Internal-API-Features.adoc[tabsize=4] +include::Dev-Logging.adoc[tabsize=4] +include::Dev-Variables-Stack.adoc[tabsize=4] +include::Dev-Port-WindRide-Functionality-to-Windup.adoc[tabsize=4] +include::Dev-Git-Rebasing.adoc[tabsize=4] + +== Rules topics + +include::Rules-Available-Rules-Utilities.adoc[tabsize=4] +include::Dev-Concepts-and-Philosophy.adoc[tabsize=4] +include::Rules-Creating-Rule-Operations.adoc[tabsize=4] +include::Rules-Rulesets.adoc[tabsize=4] +include::Ruleset-Java-Basic-Ruleset.adoc[tabsize=4] +include::Ruleset-Java-Classifications-and-Inline-Hints.adoc[tabsize=4] +include::Ruleset-Java-EE-Apps.adoc[tabsize=4] +include::Ruleset-Java-EE-Servers.adoc[tabsize=4] +include::Ruleset-Reporting.adoc[tabsize=4] +include::Ruleset-XML.adoc[tabsize=4] +include::Rules-Windup-Models.adoc[tabsize=4] +include::Rules-Create-Java-Queries.adoc[tabsize=4] +include::Rules-Rules-Metadata.adoc[tabsize=4] +include::Rules-Rules-Operations.adoc[tabsize=4] +include::Rules-Ops-Reporting-Classification.adoc[tabsize=4] +include::Rules-Ops-Reporting-Hint.adoc[tabsize=4] +include::Rules-Ops-Reporting-TypeReference.adoc[tabsize=4] +include::Rules-Ops-Xml-XsltTrasformation.adoc[tabsize=4] + +== Debugging and Troubleshooting + +include::Dev-Debugging-and-Profiling.adoc[tabsize=4] +include::Dev-Troubleshoot-Windup-Issues.adoc[tabsize=4] + +==== Wiki and Product Documentation + +include::About-the-Windup-Wiki.adoc[tabsize=4] +include::Dev-Add-Images-to-the-Windup-Wiki.adoc[tabsize=4] +include::Dev-Create-Windup-JavaDoc.adoc[tabsize=4] +include::Dev-Windup-Documentation-Process.adoc[tabsize=4] + +== Additional Resources + +include::Review-the-Windup-Quickstarts.adoc[tabsize=4] +include::Known-Issues.adoc[tabsize=4] +include::Glossary.adoc[tabsize=4] + diff --git a/scripts/pagelinksRulesDevelopmentGuide.sh b/scripts/pagelinksRulesDevelopmentGuide.sh new file mode 100755 index 0000000000..c1ba981e1f --- /dev/null +++ b/scripts/pagelinksRulesDevelopmentGuide.sh @@ -0,0 +1,72 @@ +#!/bin/bash + +# Windup Rules Development Guide + +pwd + +## Overview + +grep 'link:[A-Z]' `find . -name 'What-is-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Features-of-Windup-2.0.adoc'` +grep 'link:[A-Z]' `find . -name 'Windup-Processing-Overview.adoc'` +grep 'link:[A-Z]' `find . -name 'Get-Involved.adoc'` +grep 'link:[A-Z]' `find . -name 'Report-Issues-with-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'About-the-WINDUP_HOME-Variable.adoc'` + +## Get Started + +grep 'link:[A-Z]' `find . -name 'Install-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Execute-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Review-the-Report.adoc'` + + +## Configure Your System for Java-based Rules + +grep 'link:[A-Z]' `find . -name 'Install-and-Configure-Maven.adoc'` + +## Understand the Rule Processing + +grep 'link:[A-Z]' `find . -name 'Windup-Processing-Overview.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rule-Execution-Lifecycle.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Rule-Story-Points.adoc'` + +## Create and Test Java Rule Addons + +grep 'link:[A-Z]' `find . -name 'Rules-Java-based-Rule-Structure.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Basic-Rule-Execution-Flow-Patterns.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Create-an-Advanced-Ruleset.adoc'` + +## Create and Test XML Rules + +grep 'link:[A-Z]' `find . -name 'Rules-Create-a-Basic-XML-Rule.adoc'` + +## Review the Report + +grep 'link:[A-Z]' `find . -name 'Review-the-Report.adoc'` + +## External Rule Examples + +grep 'link:[A-Z]' `find . -name 'Review-the-Windup-Quickstarts.adoc'` + +## Debugging and Troubleshooting + +grep 'link:[A-Z]' `find . -name 'Dev-Debugging-and-Profiling.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Troubleshoot-Windup-Issues.adoc'` + + +## Additional Resources + +grep 'link:[A-Z]' `find . -name 'Rules-Available-Rules-Utilities.adoc'` +grep 'link:[A-Z]' `find . -name 'Review-the-Windup-Quickstarts.adoc'` +grep 'link:[A-Z]' `find . -name 'Known-Issues.adoc'` +grep 'link:[A-Z]' `find . -name 'Glossary.adoc'` + +## Appendix + +grep 'link:[A-Z]' `find . -name 'Windup-Architectural-Components.adoc'` +grep 'link:[A-Z]' `find . -name 'Dev-Dependencies.adoc'` +grep 'link:[A-Z]' `find . -name 'Rules-Windup-Models.adoc'` + + + diff --git a/scripts/pagelinksRulesDevelopmentGuide.txt b/scripts/pagelinksRulesDevelopmentGuide.txt new file mode 100644 index 0000000000..b9efdb3ae1 --- /dev/null +++ b/scripts/pagelinksRulesDevelopmentGuide.txt @@ -0,0 +1,89 @@ += Windup Rules Development Guide + +:toc: +:toclevels: 4 + + +== Overview + +This guide is for engineers, consultants, and others who plan to use +Windup 2.0 to migrate Java applications or other components. + +NOTE: This is a very rough first draft! + +include::What-is-Windup.adoc[tabsize=4] + +include::Features-of-Windup-2.0.adoc[tabsize=4] + +include::Windup-Processing-Overview.adoc[tabsize=4] + +include::Get-Involved.adoc[tabsize=4] + +include::Report-Issues-with-Windup.adoc[tabsize=4] + +include::About-the-WINDUP_HOME-Variable.adoc[tabsize=4] + + +== Get Started + +include::Install-Windup.adoc[tabsize=4] + +include::Execute-Windup.adoc[tabsize=4] + +include::Review-the-Report.adoc[tabsize=4] + + +== Configure Your System for Java-based Rules + +If you plan to create Java-based rule addons, you must also do the following. + +include::Install-and-Configure-Maven.adoc[tabsize=4] + +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. + +== Understand the Rule Processing + +include::Windup-Processing-Overview.adoc[tabsize=4] +include::Rules-Rule-Execution-Lifecycle.adoc[tabsize=4] +include::Rules-Rule-Story-Points.adoc[tabsize=4] + +== Create and Test Java Rule Addons + +include::Rules-Java-based-Rule-Structure.adoc[tabsize=4] +include::Rules-Basic-Rule-Execution-Flow-Patterns.adoc[tabsize=4] +include::Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc[tabsize=4] +include::Rules-Create-an-Advanced-Ruleset.adoc[tabsize=4] + +== Create and Test XML Rules + +include::Rules-Create-a-Basic-XML-Rule.adoc[tabsize=4] + +== Review the Report + +include::Review-the-Report.adoc[tabsize=4] + +== External Rule Examples + +include::Review-the-Windup-Quickstarts.adoc[tabsize=4] + +== Debugging and Troubleshooting + +include::Dev-Debugging-and-Profiling.adoc[tabsize=4] +include::Dev-Troubleshoot-Windup-Issues.adoc[tabsize=4] + + +== Additional Resources + +include::Rules-Available-Rules-Utilities.adoc[tabsize=4] +include::Review-the-Windup-Quickstarts.adoc[tabsize=4] +include::Known-Issues.adoc[tabsize=4] +include::Glossary.adoc[tabsize=4] + +== Appendix + +include::Windup-Architectural-Components.adoc[tabsize=4] +include::Dev-Dependencies.adoc[tabsize=4] +include::Rules-Windup-Models.adoc[tabsize=4] + + + diff --git a/scripts/pagelinksUserGuide.sh b/scripts/pagelinksUserGuide.sh new file mode 100755 index 0000000000..47aff2e99e --- /dev/null +++ b/scripts/pagelinksUserGuide.sh @@ -0,0 +1,31 @@ +#!/bin/bash +## Windup User Guide: Find internal links +#cd ~/GitRepos/windup-documentation/docs +pwd + +## Overview + +grep 'link:[A-Z]' `find . -name 'What-is-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Features-of-Windup-2.0.adoc'` +grep 'link:[A-Z]' `find . -name 'Windup-Processing-Overview.adoc'` +grep 'link:[A-Z]' `find . -name 'Get-Involved.adoc'` +grep 'link:[A-Z]' `find . -name 'Report-Issues-with-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'About-the-WINDUP_HOME-Variable.adoc'` + +## Run Windup + +grep 'link:[A-Z]' `find . -name 'Install-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Execute-Windup.adoc'` +grep 'link:[A-Z]' `find . -name 'Review-the-Report.adoc'` + +## Additional Resources + +grep 'link:[A-Z]' `find . -name 'Review-the-Windup-Quickstarts.adoc'` +grep 'link:[A-Z]' `find . -name 'Known-Issues.adoc'` +grep 'link:[A-Z]' `find . -name 'Glossary.adoc'` +grep 'link:[A-Z]' `find . -name 'Windup-Architectural-Components.adoc'` + + + + + diff --git a/scripts/pagelinksUserGuide.txt b/scripts/pagelinksUserGuide.txt new file mode 100644 index 0000000000..51b2ab5961 --- /dev/null +++ b/scripts/pagelinksUserGuide.txt @@ -0,0 +1,48 @@ += Windup User Guide + +:toc: +:toclevels: 4 + + +== Overview + +This guide is for engineers, consultants, and others who plan to use +Windup 2.0 to migrate Java applications or other components. + +NOTE: This is a very rough first draft! + +include::What-is-Windup.adoc[tabsize=4] + +include::Features-of-Windup-2.0.adoc[tabsize=4] + +include::Windup-Processing-Overview.adoc[tabsize=4] + +include::Get-Involved.adoc[tabsize=4] + +include::Report-Issues-with-Windup.adoc[tabsize=4] + +include::About-the-WINDUP_HOME-Variable.adoc[tabsize=4] + + +== Run Windup + +include::Install-Windup.adoc[tabsize=4] + +include::Execute-Windup.adoc[tabsize=4] + +include::Review-the-Report.adoc[tabsize=4] + +== Additional Resources + +include::Review-the-Windup-Quickstarts.adoc[tabsize=4] + +include::Known-Issues.adoc[tabsize=4] + +include::Glossary.adoc[tabsize=4] + +include::Windup-Architectural-Components.adoc[tabsize=4] + + + + + diff --git a/scripts/windupDocPublish.sh b/scripts/windupDocPublish.sh index fbd90097d9..d57df39eb0 100755 --- a/scripts/windupDocPublish.sh +++ b/scripts/windupDocPublish.sh @@ -2,14 +2,26 @@ # Publish the Windup Guides ################################# -# +WINDUP_VERSION=2.0.0.Beta7 +# if [$1 != ""]; then +# +# fi echo "Copying the HTML files from windup-documentation/html/" cd ~/GitRepos/windup git fetch upstream git checkout gh-pages -cd ../windup-documentation -cp html/*.html docs/*.css ../windup/docs/2.0.0.Beta6/html -cp docs/images/* ../windup/docs/2.0.0.Beta6/html/images/ +cd docs/ + +echo Testing for existence of $WINDUP_VERSION +if [ ! -d $WINDUP_VERSION ]; then + echo Creating directory: $WINDUP_VERSION + mkdir -p $WINDUP_VERSION/html/images +fi +cd ../../windup-documentation + +cp html/*.html ../windup/docs/$WINDUP_VERSION/html/ +cp docs/*.css ../windup/docs/$WINDUP_VERSION/html/ +cp docs/images/* ../windup/docs/$WINDUP_VERSION/html/images/ # cd ../windup # git add docs diff --git a/scripts/windupDocUpdate.sh b/scripts/windupDocUpdate.sh index 2b7a26e22c..eadb4a08fc 100755 --- a/scripts/windupDocUpdate.sh +++ b/scripts/windupDocUpdate.sh @@ -1,220 +1,313 @@ -################################# -# Build the Windup Guides -################################# - -# 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. -echo "Fetching the latest pages from the Windup Wiki..." -cd ~/GitRepos/windup.wiki +#!/bin/bash +if [ "$1" == "" ] || [ "$2" == "" ]; then + + echo "You must pass the path to the windup.wiki and windup-documentation GitHub directories on the command line." + echo "For example:" + echo " scripts/windupDocUpdate.sh ~/GitRepos/windup.wiki ~/GitRepos/windup-documentation/" + exit +else + echo "Windup Wiki pages will be copied from here: " $1 + echo "Windup Documentation will be created here: " $2 +fi + +echo "*******************************************" +echo "* Fetching the latest pages from the Windup Wiki..." +echo "*******************************************" +cd $1 +pwd + git fetch upstream git reset --hard upstream/master -cd ../windup-documentation +cd $2 +pwd +echo "Fetch complete." +echo "" # Copy the images and stylesheets: -echo "Copying the latest images and stylesheets..." -cp -r ../windup.wiki/images docs/ -cp ../windup.wiki/*.css docs/ +echo "*******************************************" +echo "* Copying the latest images and stylesheets..." +echo "*******************************************" +cp -r $1/images docs/ +# There don't seem to be any css files in the Wiki that are needed. +# cp $1/*.css docs/ +echo "Copy complete." +echo "" + +echo "*******************************************" +echo "* Copying the User Guide Wiki pages from the Wiki to windup-documentation..." +echo "*******************************************" -################################# -# Windup User Guide -################################# -echo "Copying the User Guide Wiki pages from the Wiki to windup-documentation..." +## Copy the current guide to a text file for conversion to a script +cp docs/Windup-User-Guide.adoc scripts/pageLinksUserGuide.txt ## Copy the guide page as-is to use for comparison -cp ../windup.wiki/User-Guide.asciidoc docs/ +cp $1/User-Guide.asciidoc docs/ ## Overview -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 +cp $1/What-is-Windup.asciidoc docs/What-is-Windup.adoc +cp $1/Features-of-Windup-2.0.asciidoc docs/Features-of-Windup-2.0.adoc +cp $1/Windup-Processing-Overview.asciidoc docs/Windup-Processing-Overview.adoc +cp $1/Get-Involved.asciidoc docs/Get-Involved.adoc +cp $1/Report-Issues-with-Windup.asciidoc docs/Report-Issues-with-Windup.adoc +cp $1/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 +cp $1/Install-Windup.asciidoc docs/Install-Windup.adoc +cp $1/Execute-Windup.asciidoc docs/Execute-Windup.adoc +cp $1/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 +cp $1/Review-the-Windup-Quickstarts.asciidoc docs/Review-the-Windup-Quickstarts.adoc +cp $1/Known-Issues.asciidoc docs/Known-Issues.adoc +cp $1/Glossary.asciidoc docs/Glossary.adoc +cp $1/Windup-Architectural-Components.asciidoc docs/Windup-Architectural-Components.adoc +echo "Copy complete." +echo "" + +echo "*******************************************" +echo "* Copying the Rules Development Guide Wiki pages from the Wiki to windup-documentation..." +echo "*******************************************" -################################# -# Windup Rules Development Guide -################################# -echo "Copying the Rules Development Guide Wiki pages from the Wiki to windup-documentation..." +## Copy the current guide to a text file for conversion to a script +cp docs/Windup-Rules-Development-Guide.adoc scripts/pageLinksRulesDevelopmentGuide.txt ## Copy the guide page as-is to use for comparison -cp ../windup.wiki/Rules-Development-Guide.asciidoc docs/ +cp $1/Rules-Development-Guide.asciidoc docs/ ## Overview -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 +cp $1/What-is-Windup.asciidoc docs/What-is-Windup.adoc +cp $1/Features-of-Windup-2.0.asciidoc docs/Features-of-Windup-2.0.adoc +cp $1/Get-Involved.asciidoc docs/Get-Involved.adoc +cp $1/Report-Issues-with-Windup.asciidoc docs/Report-Issues-with-Windup.adoc +cp $1/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 +cp $1/Install-Windup.asciidoc docs/Install-Windup.adoc +cp $1/Execute-Windup.asciidoc docs/Execute-Windup.adoc +cp $1/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 +cp $1/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 +cp $1/Windup-Processing-Overview.asciidoc docs/Windup-Processing-Overview.adoc +cp $1/Rules-Rule-Execution-Lifecycle.asciidoc docs/Rules-Rule-Execution-Lifecycle.adoc +cp $1/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 +cp $1/Rules-Java-based-Rule-Structure.asciidoc docs/Rules-Java-based-Rule-Structure.adoc +cp $1/Rules-Basic-Rule-Execution-Flow-Patterns.asciidoc docs/Rules-Basic-Rule-Execution-Flow-Patterns.adoc +cp $1/Rules-Create-a-Basic-Java-based-Rule-Add-on.asciidoc docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc +cp $1/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 +cp $1/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 +cp $1/Dev-Debugging-and-Profiling.asciidoc docs/Dev-Debugging-and-Profiling.adoc +cp $1/Dev-Troubleshoot-Windup-Issues.asciidoc docs/Dev-Troubleshoot-Windup-Issues.adoc ## Additional 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 +cp $1/Rules-Available-Rules-Utilities.asciidoc docs/Rules-Available-Rules-Utilities.adoc +cp $1/Review-the-Windup-Quickstarts.asciidoc docs/Review-the-Windup-Quickstarts.adoc +cp $1/Known-Issues.asciidoc docs/Known-Issues.adoc +cp $1/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 $1/Windup-Architectural-Components.asciidoc docs/Windup-Architectural-Components.adoc +cp $1/Dev-Dependencies.asciidoc docs/Dev-Dependencies.adoc +cp $1/Rules-Windup-Models.asciidoc docs/Rules-Windup-Models.adoc +echo "Copy complete." +echo "" + +echo "*******************************************" +echo "*Copying the Core Development Guide Wiki pages from the Wiki to windup-documentation..." +echo "*******************************************" -################################# -# Windup Core Development Guide -################################# -echo "Copying the Core Development Guide Wiki pages from the Wiki to windup-documentation..." +## Copy the current guide to a text file for conversion to a script +cp docs/Windup-Core-Development-Guide.adoc scripts/pageLinksCoreDevelopmentGuide.txt -## Wiki Guide -cp ../windup.wiki/Core-Development-Guide.asciidoc docs/ +## Copy the guide page as-is to use for comparison +cp $1/Core-Development-Guide.asciidoc docs/ ## Overview -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/Dev-Windup-Project-Information.asciidoc docs/Dev-Windup-Project-Information.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 +cp $1/What-is-Windup.asciidoc docs/What-is-Windup.adoc +cp $1/Features-of-Windup-2.0.asciidoc docs/Features-of-Windup-2.0.adoc +cp $1/Get-Involved.asciidoc docs/Get-Involved.adoc +cp $1/Dev-Windup-Project-Information.asciidoc docs/Dev-Windup-Project-Information.adoc +cp $1/Report-Issues-with-Windup.asciidoc docs/Report-Issues-with-Windup.adoc +cp $1/About-the-WINDUP_HOME-Variable.asciidoc docs/About-the-WINDUP_HOME-Variable.adoc ## Developer Contributing Information -cp ../windup.wiki/Dev-Development-Guidelines.asciidoc docs/Dev-Development-Guidelines.adoc -cp ../windup.wiki/Dev-Submit-Code-Updates-to-the-Windup-Project.asciidoc docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc +cp $1/Dev-Development-Guidelines.asciidoc docs/Dev-Development-Guidelines.adoc +cp $1/Dev-Submit-Code-Updates-to-the-Windup-Project.asciidoc docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc ## Understand the Windup Architecture and Structure -cp ../windup.wiki/Dev-Windup-Architectural-Components.asciidoc docs/Dev-Windup-Architectural-Components.adoc -cp ../windup.wiki/Dev-Windup-Project-Structure.asciidoc docs/Dev-Windup-Project-Structure.adoc +cp $1/Windup-Architectural-Components.asciidoc docs/Windup-Architectural-Components.adoc +cp $1/Dev-Windup-Project-Structure.asciidoc docs/Dev-Windup-Project-Structure.adoc ## Get Started -cp ../windup.wiki/Install-and-Configure-Maven.asciidoc docs/Install-and-Configure-Maven.adoc -cp ../windup.wiki/Dev-Get-the-Windup-Source-Code.asciidoc docs/Dev-Get-the-Windup-Source-Code.adoc -cp ../windup.wiki/Dev-Build-Windup-from-Source.asciidoc docs/Dev-Build-Windup-from-Source.adoc -cp ../windup.wiki/Dev-Execute-Windup-Built-from-Source.asciidoc docs/Dev-Execute-Windup-Built-from-Source.adoc -cp ../windup.wiki/Execute-Windup.asciidoc docs/Execute-Windup.adoc -cp ../windup.wiki/Review-the-Report.asciidoc docs/Review-the-Report.adoc +cp $1/Install-and-Configure-Maven.asciidoc docs/Install-and-Configure-Maven.adoc +cp $1/Dev-Get-the-Windup-Source-Code.asciidoc docs/Dev-Get-the-Windup-Source-Code.adoc +cp $1/Dev-Build-Windup-from-Source.asciidoc docs/Dev-Build-Windup-from-Source.adoc +cp $1/Dev-Execute-Windup-Built-from-Source.asciidoc docs/Dev-Execute-Windup-Built-from-Source.adoc +cp $1/Execute-Windup.asciidoc docs/Execute-Windup.adoc +cp $1/Review-the-Report.asciidoc docs/Review-the-Report.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 +cp $1/Windup-Processing-Overview.asciidoc docs/Windup-Processing-Overview.adoc +cp $1/Rules-Rule-Execution-Lifecycle.asciidoc docs/Rules-Rule-Execution-Lifecycle.adoc +cp $1/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 +cp $1/Rules-Java-based-Rule-Structure.asciidoc docs/Rules-Java-based-Rule-Structure.adoc +cp $1/Rules-Basic-Rule-Execution-Flow-Patterns.asciidoc docs/Rules-Basic-Rule-Execution-Flow-Patterns.adoc +cp $1/Rules-Create-a-Basic-Java-based-Rule-Add-on.asciidoc docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc +cp $1/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 +cp $1/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 +cp $1/Dev-Debugging-and-Profiling.asciidoc docs/Dev-Debugging-and-Profiling.adoc +cp $1/Dev-Troubleshoot-Windup-Issues.asciidoc docs/Dev-Troubleshoot-Windup-Issues.adoc ## Wiki and Product Documentation -cp ../windup.wiki/About-the-Windup-Wiki.asciidoc docs/About-the-Windup-Wiki.adoc -cp ../windup.wiki/Dev-Add-Images-to-the-Windup-Wiki.asciidoc docs/Dev-Add-Images-to-the-Windup-Wiki.adoc -cp ../windup.wiki/Dev-Create-Windup-JavaDoc.asciidoc docs/Dev-Create-Windup-JavaDoc.adoc -cp ../windup.wiki/Dev-Windup-Documentation-Process.asciidoc docs/Dev-Windup-Documentation-Process.adoc +cp $1/About-the-Windup-Wiki.asciidoc docs/About-the-Windup-Wiki.adoc +cp $1/Dev-Add-Images-to-the-Windup-Wiki.asciidoc docs/Dev-Add-Images-to-the-Windup-Wiki.adoc +cp $1/Dev-Create-Windup-JavaDoc.asciidoc docs/Dev-Create-Windup-JavaDoc.adoc +cp $1/Dev-Windup-Documentation-Process.asciidoc docs/Dev-Windup-Documentation-Process.adoc ## Additional 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 +cp $1/Review-the-Windup-Quickstarts.asciidoc docs/Review-the-Windup-Quickstarts.adoc +cp $1/Known-Issues.asciidoc docs/Known-Issues.adoc +cp $1/Glossary.asciidoc docs/Glossary.adoc ## Dev topics -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/Dev-Windup-Bootstrap.asciidoc docs/Dev-Windup-Bootstrap.adoc -cp ../windup.wiki/Dev-Classloading-Notes.asciidoc docs/Dev-Classloading-Notes.adoc -cp ../windup.wiki/Dev-Connect-to-the-Graph-via-Rexster.asciidoc docs/Dev-Connect-to-the-Graph-via-Rexster.adoc -cp ../windup.wiki/Dev-Decompiling.asciidoc docs/Dev-Decompiling.adoc -cp ../windup.wiki/Dev-Frames-Extensions.asciidoc docs/Dev-Frames-Extensions.adoc -cp ../windup.wiki/Dev-Internal-API-Features.asciidoc docs/Dev-Internal-API-Features.adoc -cp ../windup.wiki/Dev-Logging.asciidoc docs/Dev-Logging.adoc -cp ../windup.wiki/Dev-Variables-Stack.asciidoc docs/Dev-Variables-Stack.adoc -cp ../windup.wiki/Dev-Port-WindRide-Functionality-to-Windup.asciidoc docs/Dev-Port-WindRide-Functionality-to-Windup.adoc -cp ../windup.wiki/Dev-Git-Rebasing.asciidoc docs/Dev-Git-Rebasing.adoc +cp $1/Windup-Architectural-Components.asciidoc docs/Windup-Architectural-Components.adoc +cp $1/Dev-Dependencies.asciidoc docs/Dev-Dependencies.adoc + +cp $1/Dev-Windup-Bootstrap.asciidoc docs/Dev-Windup-Bootstrap.adoc +cp $1/Dev-Classloading-Notes.asciidoc docs/Dev-Classloading-Notes.adoc +cp $1/Dev-Connect-to-the-Graph-via-Rexster.asciidoc docs/Dev-Connect-to-the-Graph-via-Rexster.adoc +cp $1/Dev-Decompiling.asciidoc docs/Dev-Decompiling.adoc +cp $1/Dev-Frames-Extensions.asciidoc docs/Dev-Frames-Extensions.adoc +cp $1/Dev-Internal-API-Features.asciidoc docs/Dev-Internal-API-Features.adoc +cp $1/Dev-Logging.asciidoc docs/Dev-Logging.adoc +cp $1/Dev-Variables-Stack.asciidoc docs/Dev-Variables-Stack.adoc +cp $1/Dev-Port-WindRide-Functionality-to-Windup.asciidoc docs/Dev-Port-WindRide-Functionality-to-Windup.adoc +cp $1/Dev-Git-Rebasing.asciidoc docs/Dev-Git-Rebasing.adoc ## Rule topics -cp ../windup.wiki/Rules-Windup-Models.asciidoc docs/Rules-Windup-Models.adoc -cp ../windup.wiki/Rules-Available-Rules-Utilities.asciidoc docs/Rules-Available-Rules-Utilities.adoc -cp ../windup.wiki/Dev-Concepts-and-Philosophy.asciidoc docs/Dev-Concepts-and-Philosophy.adoc -cp ../windup.wiki/Rules-Creating-Rule-Operations.asciidoc docs/Rules-Creating-Rule-Operations.adoc -cp ../windup.wiki/Rules-Rulesets.asciidoc docs/Rules-Rulesets.adoc -cp ../windup.wiki/Ruleset-Java-Basic-Ruleset.asciidoc docs/Ruleset-Java-Basic-Ruleset.adoc -cp ../windup.wiki/Ruleset-Java-Classifications-and-Inline-Hints.asciidoc docs/Ruleset-Java-Classifications-and-Inline-Hints.adoc -cp ../windup.wiki/Ruleset-Java-EE-Apps.asciidoc docs/Ruleset-Java-EE-Apps.adoc -cp ../windup.wiki/Ruleset-Java-EE-Servers.asciidoc docs/Ruleset-Java-EE-Servers.adoc -cp ../windup.wiki/Ruleset-Reporting.asciidoc docs/Ruleset-Reporting.adoc -cp ../windup.wiki/Ruleset-XML.asciidoc docs/Ruleset-XML.adoc -cp ../windup.wiki/Rules-Windup-Models.asciidoc docs/Rules-Windup-Models.adoc -cp ../windup.wiki/Rules-Create-Java-Queries.asciidoc docs/Rules-Create-Java-Queries.adoc -cp ../windup.wiki/Rules-Rules-Metadata.asciidoc docs/Rules-Rules-Metadata.adoc -cp ../windup.wiki/Rules-Rules-Operations.asciidoc docs/Rules-Rules-Operations.adoc -cp ../windup.wiki/Rules-Ops-Reporting-Classification.asciidoc docs/Rules-Ops-Reporting-Classification.adoc -cp ../windup.wiki/Rules-Ops-Reporting-Hint.asciidoc docs/Rules-Ops-Reporting-Hint.adoc -cp ../windup.wiki/Rules-Ops-Reporting-TypeReference.asciidoc docs/Rules-Ops-Reporting-TypeReference.adoc -cp ../windup.wiki/Rules-Ops-Xml-XsltTrasformation.asciidoc docs/Rules-Ops-Xml-XsltTrasformation.adoc -cp ../windup.wiki/Rules-Rule-Execution-Lifecycle.asciidoc docs/Rules-Rule-Execution-Lifecycle.adoc -cp ../windup.wiki/Rules-Java-based-Rule-Structure.asciidoc docs/Rules-Java-based-Rule-Structure.adoc -cp ../windup.wiki/Rules-Rule-Story-Points.asciidoc docs/Rules-Rule-Story-Points.adoc - -## Manually verify the internal links and anchors -echo "" -echo "Find the internal links within pages and make sure each referenced section " -echo "has an anchor defined with dashes and double brackets. For example: " -echo "" -echo "[[section-header]]" -echo "=== Section Header" -grep 'xref:[a-z]' `find . -name '*.adoc'` - -## Manually verify the external page links and make sure the pages are included in the books +cp $1/Rules-Windup-Models.asciidoc docs/Rules-Windup-Models.adoc +cp $1/Rules-Available-Rules-Utilities.asciidoc docs/Rules-Available-Rules-Utilities.adoc +cp $1/Dev-Concepts-and-Philosophy.asciidoc docs/Dev-Concepts-and-Philosophy.adoc +cp $1/Rules-Creating-Rule-Operations.asciidoc docs/Rules-Creating-Rule-Operations.adoc +cp $1/Rules-Rulesets.asciidoc docs/Rules-Rulesets.adoc +cp $1/Ruleset-Java-Basic-Ruleset.asciidoc docs/Ruleset-Java-Basic-Ruleset.adoc +cp $1/Ruleset-Java-Classifications-and-Inline-Hints.asciidoc docs/Ruleset-Java-Classifications-and-Inline-Hints.adoc +cp $1/Ruleset-Java-EE-Apps.asciidoc docs/Ruleset-Java-EE-Apps.adoc +cp $1/Ruleset-Java-EE-Servers.asciidoc docs/Ruleset-Java-EE-Servers.adoc +cp $1/Ruleset-Reporting.asciidoc docs/Ruleset-Reporting.adoc +cp $1/Ruleset-XML.asciidoc docs/Ruleset-XML.adoc +cp $1/Rules-Windup-Models.asciidoc docs/Rules-Windup-Models.adoc +cp $1/Rules-Create-Java-Queries.asciidoc docs/Rules-Create-Java-Queries.adoc +cp $1/Rules-Rules-Metadata.asciidoc docs/Rules-Rules-Metadata.adoc +cp $1/Rules-Rules-Operations.asciidoc docs/Rules-Rules-Operations.adoc +cp $1/Rules-Ops-Reporting-Classification.asciidoc docs/Rules-Ops-Reporting-Classification.adoc +cp $1/Rules-Ops-Reporting-Hint.asciidoc docs/Rules-Ops-Reporting-Hint.adoc +cp $1/Rules-Ops-Reporting-TypeReference.asciidoc docs/Rules-Ops-Reporting-TypeReference.adoc +cp $1/Rules-Ops-Xml-XsltTransformation.asciidoc docs/Rules-Ops-Xml-XsltTransformation.adoc +cp $1/Rules-Rule-Execution-Lifecycle.asciidoc docs/Rules-Rule-Execution-Lifecycle.adoc +cp $1/Rules-Java-based-Rule-Structure.asciidoc docs/Rules-Java-based-Rule-Structure.adoc +cp $1/Rules-Rule-Story-Points.asciidoc docs/Rules-Rule-Story-Points.adoc +echo "Copy complete." echo "" -echo "Search for links to other pages and make sure the linked pages are part of the book." -grep 'link:[A-Z]' `find . -name '*.adoc'` -## Replace external links with xrefs -echo "Replace the external links to other pages with xrefs:" -find . -name 'Windup-User-Guide.adoc' -print | xargs sed -i 's/link:/xref:/g' -find . -name 'Windup-Rules-Development-Guide.adoc' -print | xargs sed -i 's/link:/xref:/g' -find . -name 'Windup-Core-Development-Guide.adoc' -print | xargs sed -i 's/link:/xref:/g' -#find . -name 'Windup-Migration-Planning-Guide.adoc' -print | xargs sed -i 's/link:/xref:/g' +echo "*******************************************" +echo "* MANUAL STEP!" +echo "*" +echo "* Find the internal links within the following pages and make sure " +echo "* each referenced section has an anchor defined with dashes and double brackets." +echo "* For example: " +echo "*" +echo "* [[section-header]]" +echo "* === Section Header" +echo "*******************************************" +echo "" +cd docs +grep 'xref:[a-z]' `find . -name '*.adoc'` +cd ../ +echo "" +echo "Verify items in list above. ^^" +echo "" +echo "" +echo "" +echo "*******************************************" +echo "* MANUAL STEP!" +echo "*" +echo "* Search the User Guide to find pages that link to other pages." +echo "* Make sure the linked to pages are part of the book." +echo "*******************************************" +echo "" +cd docs +sh $2/scripts/pagelinksUserGuide.sh +# grep 'link:[A-Z]' `find . -name '*.adoc'` +cd ../ +echo "" +echo "Verify items in list above. ^^" +echo "" +echo "" +echo "*******************************************" +echo "* MANUAL STEP!" +echo "*" +echo "* Search the Rule Development Guide to find pages that link to other pages." +echo "* Make sure the linked to pages are part of the book." +echo "*******************************************" +echo "" +cd docs +sh $2/scripts/pagelinksRulesDevelopmentGuide.sh +# grep 'link:[A-Z]' `find . -name '*.adoc'` +cd ../ +echo "" +echo "Verify items in list above. ^^" +echo "" +echo "*******************************************" +echo "* MANUAL STEP!" +echo "*" +echo "* Search the Core Development Guide to find pages that link to other pages." +echo "* Make sure the linked to pages are part of the book." +echo "*******************************************" +echo "" +cd docs +sh $2/scripts/pagelinksCoreDevelopmentGuide.sh +# grep 'link:[A-Z]' `find . -name '*.adoc'` +cd ../ +echo "" +echo "Verify items in list above. ^^" +echo "" +echo "*******************************************" +echo "* Replacing the links: to external pages with xrefs:" +echo "*******************************************" +echo "" +cd docs +find . -name '*.adoc' -print | xargs sed -i 's/link:/xref:/g' +cd ../ +echo "Replacement of links with xrefs is complete." +echo "" -# Build the books -echo "Building the Windup User Guide..." +echo "*******************************************" +echo "* Building the Windup User Guide..." +echo "*******************************************" asciidoctor -t -dbook -a toc -o html/WindupUserGuide.html docs/Windup-User-Guide.adoc +echo "Guide is located at: " file://$2/html/WindupUserGuide.html +echo "" -echo "Building the Windup Rules Development Guide..." +echo "*******************************************" +echo "* Building the Windup Rules Development Guide..." +echo "*******************************************" asciidoctor -t -dbook -a toc -o html/WindupRulesDevelopmentGuide.html docs/Windup-Rules-Development-Guide.adoc +echo "Guide is located at: " file://$2/html/WindupRulesDevelopmentGuide.html +echo "" -echo "Building the Windup Core Development Guide..." +echo "*******************************************" +echo "* Building the Windup Core Development Guide..." +echo "*******************************************" asciidoctor -t -dbook -a toc -o html/WindupCoreDevelopmentGuide.html docs/Windup-Core-Development-Guide.adoc +echo "Guide is located at: " file://$2/html/WindupCoreDevelopmentGuide.html +echo ""