diff --git a/docs/Dev-Build-Windup-from-Source.adoc b/docs/Dev-Build-Windup-from-Source.adoc index 28140db390..52be9f6211 100644 --- a/docs/Dev-Build-Windup-from-Source.adoc +++ b/docs/Dev-Build-Windup-from-Source.adoc @@ -17,7 +17,7 @@ Oracle Java SE . Maven 3.1.1 or newer + If you have not yet installed or configured Maven, see -xref:Install-and-Configure-Maven[Install and Configure Maven] for details. +link: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: @@ -35,15 +35,15 @@ Developer Studio 7.1.1] or newer + You must also make sure the IDE embeds Maven 3.1.1 or later. See -xref:Install-and-Configure-Maven[Install and Configure Maven] for details. +link: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: -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. +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. . 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 1963bd5043..00332815b8 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: xref:Windup-Processing-Overview[Windup Processing Overview] ?_ +_TODO - OZIZKA: Can this topic be marked obsolete and be replaced by this one: link: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 xref:Rules-Windup-Models[Windup Models]. +See also the list of link: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 f1938946e9..d22c77dea1 100644 --- a/docs/Dev-Execute-Windup-Built-from-Source.adoc +++ b/docs/Dev-Execute-Windup-Built-from-Source.adoc @@ -10,7 +10,7 @@ NOTE: If you used previous versions of Windup, delete the `${user.home}/.forge/a ==== Unzip the Windup Distribution -1. Follow the procedures to xref:Dev-Build-Windup-from-Source[build Windup from source]. This creates a `windup-distribution-2.0.0-SNAPSHOT-offline.zip` file in the Windup source `dist/target` directory. Note, the version may be different than the one used in these instructions. +1. Follow the procedures to link:Dev-Build-Windup-from-Source[build Windup from source]. This creates a `windup-distribution-2.0.0-SNAPSHOT-offline.zip` file in the Windup source `dist/target` directory. Note, the version may be different than the one used in these instructions. 2. Unzip the `dist/target/windup-distribution-2.0.0-SNAPSHOT-offline.zip` ZIP file. ==== Run Windup @@ -75,7 +75,7 @@ The following subdirectories in the `OUTPUT_REPORT_DIRECTORY` contain the suppor stats/ index.html -8. For details on how to evaluate the report data, see xref:Review-the-Report[Review the Report]. +8. For details on how to evaluate the report data, see link:Review-the-Report[Review the Report]. ==== Run Windup in Batch Mode (for a shell script) diff --git a/docs/Dev-Internal-API-Features.adoc b/docs/Dev-Internal-API-Features.adoc index 0db7e4c200..2c8ab67c6b 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 xref:Rules-Metadata[Rules Metadata] +For more information about the metadata stored in the context, see link: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 55c701bbc9..0a3a06a20f 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 xref:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code] for instructions. +To get the Windup Source Code, see link: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 b6adc9d375..b7dba9fc31 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 xref:Known-Issues[Known Issues] and https://issues.jboss.org/browse/WINDUP-73[WINDUP-73] for the current status. +See link: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 xref:Known-Issues[Known Issues] and https://issues.jboss.org/browse/WINDUP-197[WINDUP-197] for the current status.. +See link: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 xref:Dev-Dependencies[Dependencies] for some hints. +See link:Dev-Dependencies[Dependencies] for some hints. diff --git a/docs/Dev-Windup-Architectural-Components.adoc b/docs/Dev-Windup-Architectural-Components.adoc index 0e221f4810..85f6d810e0 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: -xref:Dev-Frames-extensions[Frames Extensions]. +link:Dev-Frames-extensions[Frames Extensions]. ==== Gremlin diff --git a/docs/Dev-Windup-Project-Information.adoc b/docs/Dev-Windup-Project-Information.adoc index 1bc305d064..5f457965ca 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 xref:http://windup.github.io/windup/docs/javadoc/2.0.0.Beta2/[Javadoc]. +For additional information, refer to the link:http://windup.github.io/windup/docs/javadoc/2.0.0.Beta2/[Javadoc]. ==== Website diff --git a/docs/Execute-Windup.adoc b/docs/Execute-Windup.adoc index 3dd575c0ce..15c7b7208e 100644 --- a/docs/Execute-Windup.adoc +++ b/docs/Execute-Windup.adoc @@ -19,7 +19,7 @@ Before you begin, you must gather the following information. ==== Start Windup -For information about the use of WINDUP_HOME in the instructions below, see xref:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]. +For information about the use of WINDUP_HOME in the instructions below, see link:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]. . Open a terminal and navigate to the `WINDUP_HOME/bin` directory @@ -96,7 +96,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 xref:Review-the-Report[Review the Report]. +. For details on how to evaluate the report data, see link:Review-the-Report[Review the Report]. ==== Windup Help diff --git a/docs/Get-Involved.adoc b/docs/Get-Involved.adoc index 67683fcb4f..ecd35ed18f 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 guide describing how to solve the problem migration areas. -* xref:Execute-Windup[Try Windup] on your application. Be sure to xref:Report-Issues-with-Windup[report any issues] you encounter. +* link:Execute-Windup[Try Windup] on your application. Be sure to link:Report-Issues-with-Windup[report any issues] you encounter. * Write an Windup rule to automate the migration process. ** Create a test for the new rule. * You can contribute Windup rules. For details, see the _Windup Rules Development Guide_. diff --git a/docs/Install-Windup.adoc b/docs/Install-Windup.adoc index 52b9fedb12..21074624b2 100644 --- a/docs/Install-Windup.adoc +++ b/docs/Install-Windup.adoc @@ -4,4 +4,4 @@ . Download the latest Windup ZIP distribution from http://repository.jboss.org/nexus/content/groups/public/org/jboss/windup/windup-distribution. This is currently http://repository.jboss.org/nexus/content/groups/public/org/jboss/windup/windup-distribution/2.0.0.Beta6/[windup-distribution-2.0.0.Beta6]. . 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 xref:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]. +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]. 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 0727acbcb0..73c745b88c 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 xref:Install-Windup[Install Windup]. -* Be sure you xref:Install-and-Configure-Maven[Install and Configure Maven]. +* You must link:Install-Windup[Install Windup]. +* Be sure you link: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 xref: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 link: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 xref:Rules-Rule-Execution-Lifecycle[Rules Execution Lifecycles]. +For more information about rule phases, see link: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 xref:Execute-Windup[Execute Windup]. +* If you have not started Windup, follow the instructions to link: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: xref:Execute-Windup[Execute Windup] +For more information and examples of how to run Windup, see: link:Execute-Windup[Execute Windup] ==== Review the Output Report @@ -296,11 +296,11 @@ TBD. * Models ** https://github.com/tinkerpop/frames/wiki[Frames] -** xref:Rules-Windup-Models[Windup Models] +** link:Rules-Windup-Models[Windup Models] * Rules ** http://ocpsoft.org/rewrite/[OCPSoft Rewrite] ** Conditions, Operations *** Variables ** Inter-rule action -** xref:Rules:-Rules-Execution-Lifecycle[Inter-rule dependency] +** link: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 f0aaf0c13a..ea9cad805a 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 xref:Install-Windup[installed Windup]. +* You should have already link: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 xref:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecyle] for more information about rule phases. +* ****: This element specifies when the ruleset should execute. See link: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 xref: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 link: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 xref:Execute-Windup[Execute Windup]. +NOTE: If you have not started Windup, follow the instructions to link: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: xref:Execute-Windup[Execute Windup] +For more information and examples of how to run Windup, see: link:Execute-Windup[Execute Windup] diff --git a/docs/Rules-Create-an-Advanced-Ruleset.adoc b/docs/Rules-Create-an-Advanced-Ruleset.adoc index 052697794c..52f4013d88 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 -* xref:Rules-Create-a-Basic-Java-based-Rule-Add-on[Create a Basic Java-based Rule Add-on] +* link: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-Java-based-Rule-Structure.adoc b/docs/Rules-Java-based-Rule-Structure.adoc index 62a577d262..b44d1bafc7 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). -// - xref:Rules-Story-Points[How to estimate the migration effort with Story +// - link: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 xref: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 link: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 xref:Rules-Available-Rules-Utilities[Available Rules Utilities]. \ No newline at end of file +see link:Rules-Available-Rules-Utilities[Available Rules Utilities]. \ No newline at end of file diff --git a/docs/Rules-Rulesets.adoc b/docs/Rules-Rulesets.adoc index b681a84532..a30eece828 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. -xref:Ruleset-Java-Basic-Ruleset +link: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. -* xref:Ruleset-Java-Basic-Ruleset[Java Basic Ruleset] +* link: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 c61dabbd13..ef7c83bb93 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 xref: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 link:http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/graph/model/WindupVertexFrame.html[Javadoc]. image:img/WindupModels-NbScreenshot.png[Windup Models Graphic] diff --git a/docs/Windup-Processing-Overview.adoc b/docs/Windup-Processing-Overview.adoc index e540898e62..4fadff7753 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 xref:Dev-Windup-Architectural-Components[Windup Architectural Components]. +For more information about the graph database components, see link:Dev-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 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. +* 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. * 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/html/WindupCoreDevelopmentGuide.html b/html/WindupCoreDevelopmentGuide.html index d395cad6f8..18be25a16d 100644 --- a/html/WindupCoreDevelopmentGuide.html +++ b/html/WindupCoreDevelopmentGuide.html @@ -763,7 +763,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.

  • Write an Windup rule to automate the migration process.

    @@ -834,7 +834,7 @@

    Documentation

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

    -

    For additional information, refer to the Javadoc.

    +

    For additional information, refer to the Javadoc.

    @@ -1067,7 +1067,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.

      @@ -1220,7 +1220,7 @@

      Frames

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

    +Frames Extensions.

    @@ -1561,7 +1561,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 @@ -1591,7 +1591,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.

    • @@ -1603,10 +1603,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.

      @@ -1747,7 +1747,7 @@

      Unzip the Windup Distribution

      1. -

        Follow the procedures to build Windup from source. This creates a windup-distribution-2.0.0-SNAPSHOT-offline.zip file in the Windup source dist/target directory. Note, the version may be different than the one used in these instructions.

        +

        Follow the procedures to build Windup from source. This creates a windup-distribution-2.0.0-SNAPSHOT-offline.zip file in the Windup source dist/target directory. Note, the version may be different than the one used in these instructions.

      2. Unzip the dist/target/windup-distribution-2.0.0-SNAPSHOT-offline.zip ZIP file.

        @@ -1848,7 +1848,7 @@

        Run Windup

    4. -

      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.

    @@ -2178,7 +2178,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.

    @@ -2201,7 +2201,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.

      @@ -2408,7 +2408,7 @@

      Windup Rule Provider

    @@ -2734,10 +2734,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.

    @@ -2958,7 +2958,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.

  • @@ -3053,7 +3053,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:

      @@ -3096,7 +3096,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

    @@ -3127,7 +3127,7 @@

    Review the Output Report

    Frames

  • -

    Windup Models

    +

    Windup Models

    • @@ -3153,7 +3153,7 @@

    Review the Output Report

    Inter-rule action

  • -

    Inter-rule dependency

    +

    Inter-rule dependency

    • @@ -3176,7 +3176,7 @@

      Review the Output Report

      @@ -3214,7 +3214,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:

        @@ -3312,7 +3312,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.

        @@ -3387,7 +3387,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/
        @@ -3411,7 +3411,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. @@ -3436,7 +3436,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

    @@ -3996,7 +3996,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

    @@ -4351,7 +4351,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 @@ -4383,7 +4383,7 @@

    Graph database and Models (Frames)

    -

    See also the list of Windup Models.

    +

    See also the list of Windup Models.

    @@ -4447,7 +4447,7 @@

    What is a Ruleset?

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

    -

    xref:Ruleset-Java-Basic-Ruleset +

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

    @@ -4490,7 +4490,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

    @@ -5263,7 +5263,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.

    @@ -5274,14 +5274,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.

    @@ -5820,7 +5820,7 @@

    Reporting Terms

    diff --git a/html/WindupRulesDevelopmentGuide.html b/html/WindupRulesDevelopmentGuide.html index c6885d0d4f..7039de36f2 100644 --- a/html/WindupRulesDevelopmentGuide.html +++ b/html/WindupRulesDevelopmentGuide.html @@ -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.

  • Write an Windup rule to automate the migration process.

    @@ -975,7 +975,7 @@

    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. +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. @@ -1021,7 +1021,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.

      @@ -1130,7 +1130,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.

    • @@ -1531,7 +1531,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.

    @@ -1554,7 +1554,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.

      @@ -1761,7 +1761,7 @@

      Windup Rule Provider

    @@ -2087,10 +2087,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.

    @@ -2311,7 +2311,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.

  • @@ -2406,7 +2406,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:

      @@ -2449,7 +2449,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

    @@ -2480,7 +2480,7 @@

    Review the Output Report

    Frames

  • -

    Windup Models

    +

    Windup Models

    • @@ -2506,7 +2506,7 @@

    Review the Output Report

    Inter-rule action

  • -

    Inter-rule dependency

    +

    Inter-rule dependency

    • @@ -2529,7 +2529,7 @@

      Review the Output Report

      @@ -2567,7 +2567,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:

        @@ -2665,7 +2665,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.

        @@ -2740,7 +2740,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/
        @@ -2764,7 +2764,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. @@ -2789,7 +2789,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

    @@ -3182,7 +3182,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.

    @@ -3193,14 +3193,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.

    @@ -3576,7 +3576,7 @@

    Frames

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

    +Frames Extensions.

    @@ -3780,7 +3780,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

    @@ -3820,7 +3820,7 @@

    Custom Models (coming from Addons) diff --git a/html/WindupUserGuide.html b/html/WindupUserGuide.html index 8a5611b864..fedd433af6 100644 --- a/html/WindupUserGuide.html +++ b/html/WindupUserGuide.html @@ -678,7 +678,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 +701,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 +745,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.

  • Write an Windup rule to automate the migration process.

    @@ -927,7 +927,7 @@

    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. +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. @@ -973,7 +973,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.

      @@ -1082,7 +1082,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.

    • @@ -1528,7 +1528,7 @@

    Reporting Terms

    diff --git a/scripts/windupDocPublish.sh b/scripts/windupDocPublish.sh index 85bbf9300d..fbd90097d9 100755 --- a/scripts/windupDocPublish.sh +++ b/scripts/windupDocPublish.sh @@ -8,6 +8,14 @@ cd ~/GitRepos/windup git fetch upstream git checkout gh-pages cd ../windup-documentation -cp html/*.html docs/*.css docs/images/* ../windup/docs/2.0.0.Beta6/html +cp html/*.html docs/*.css ../windup/docs/2.0.0.Beta6/html +cp docs/images/* ../windup/docs/2.0.0.Beta6/html/images/ +# cd ../windup +# git add docs +# git commit -m "Update the docs" +# git push sgilda HEAD +## issue a pull and verify +# git push upstream gh-pages +#firefox http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupUserGuide.html diff --git a/scripts/windupDocUpdate.sh b/scripts/windupDocUpdate.sh index fb4d3e5c2c..0359a2bcfc 100755 --- a/scripts/windupDocUpdate.sh +++ b/scripts/windupDocUpdate.sh @@ -201,7 +201,10 @@ grep 'link:[A-Z]' `find . -name '*.adoc'` ## Replace external links with xrefs echo "Replace the external links to other pages with xrefs:" -find . -name '*.adoc' -print | xargs sed -i 's/link:/xref:/g' +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' # Build the books echo "Building the Windup User Guide..."