Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/Dev-Build-Windup-from-Source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
+
--------------
Expand Down
4 changes: 2 additions & 2 deletions docs/Dev-Concepts-and-Philosophy.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/Dev-Execute-Windup-Built-from-Source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/Dev-Internal-API-Features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/Dev-Troubleshoot-Windup-Issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@

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

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.
2 changes: 1 addition & 1 deletion docs/Dev-Windup-Architectural-Components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Dev-Windup-Project-Information.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/Execute-Windup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Get-Involved.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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_.
Expand Down
2 changes: 1 addition & 1 deletion docs/Install-Windup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
16 changes: 8 additions & 8 deletions docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -51,7 +51,7 @@ Create a new Maven Java Project. These instructions will refer to the project fo
</dependencyManagement>
----

3. 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 xref:Dev-Dependencies[Windup Dependencies].
3. 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 link:Dev-Dependencies[Windup Dependencies].
+
The following are examples of some dependencies you may need for your rule add-on.
+
Expand Down Expand Up @@ -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.
+
Expand Down Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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]
10 changes: 5 additions & 5 deletions docs/Rules-Create-a-Basic-XML-Rule.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -69,7 +69,7 @@ The following is an example of an XML rule.
The XML rule consists of the following level elements:

* **<ruleset>**: This element defines this as a Windup rule.
* **<phase>**: This element specifies when the ruleset should execute. See xref:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecyle] for more information about rule phases.
* **<phase>**: This element specifies when the ruleset should execute. See link:Rules-Rule-Execution-Lifecycle[Rule Execution Lifecyle] for more information about rule phases.
* **<rules>**: element contains the individual rules.
** **<rule>**: 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.
*** **<when>**: This element defines the condition to match on.
Expand All @@ -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.
+
Expand All @@ -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.

Expand All @@ -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]


2 changes: 1 addition & 1 deletion docs/Rules-Create-an-Advanced-Ruleset.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/Rules-Java-based-Rule-Structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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].
see link:Rules-Available-Rules-Utilities[Available Rules Utilities].
4 changes: 2 additions & 2 deletions docs/Rules-Rulesets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules-Windup-Models.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
Loading