Skip to content

Commit

Permalink
Merge pull request #95 from bergerhoffer/windup-2.5.Final-2
Browse files Browse the repository at this point in the history
Updates for the 2.5.0.Final build
  • Loading branch information
sgilda committed May 10, 2016
2 parents 01a7ba8 + 9aae65c commit 150cdbf
Show file tree
Hide file tree
Showing 16 changed files with 42 additions and 70 deletions.
2 changes: 0 additions & 2 deletions docs/topics/Get-Involved.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@





[[Get-Involved]]
=== Get Involved

Expand Down
11 changes: 5 additions & 6 deletions docs/topics/Home.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@


////



////

= Welcome to {ProductName}

Expand Down Expand Up @@ -31,17 +33,14 @@ https://github.com/windup/windup-legacy[windup-legacy] GitHub repository.
{ProductName} documentation is organized into guides that target specific audiences.

* xref:./User-Guide[{ProductName} User Guide] is for engineers, consultants, or others who plan to use
{ProductName} to migrate applications or other components. For a single page HTML version, see the {ProductDocUserGuideURL}[{ProductName} User Guide single HTML].
* xref:./Rules-Development-Guide[{ProductName} Rules Development Guide] provides details for developers, consultants, and others who plan to create custom rule add-ons for the {ProductName} project. For a single page HTML version, see the {ProductDocRulesGuideURL}[{ProductName} Rules Development Guide single HTML].
* xref:./Core-Development-Guide[{ProductName} Core Development Guide] provides information for developers who plan to contribute source code updates or core rule add-ons to the {ProductName} project. For a single page HTML version, see the {ProductDocCoreGuideURL}[{ProductName} Core Development Guide single HTML].
{ProductName} to migrate applications or other components.
* xref:./Rules-Development-Guide[{ProductName} Rules Development Guide] provides details for developers, consultants, and others who plan to create custom rule add-ons for the {ProductName} project.
* xref:./Core-Development-Guide[{ProductName} Core Development Guide] provides information for developers who plan to contribute source code updates or core rule add-ons to the {ProductName} project.
* xref:./Migration-Planning-Guide[Migration Planning Guide] is for developers, Project Managers, or IT managers who must interpret the {ProductShortName} reports and develop a project plan.

== Additional Resources

* {ProductShortName} Documentation
** {ProductDocUserGuideURL}[{ProductName} User Guide]
** {ProductDocRulesGuideURL}[{ProductName} Rules Development Guide]
** {ProductDocCoreGuideURL}[{ProductName} Core Development Guide]
** http://windup.github.io/windup/docs/latest/javadoc[{ProductName} JavaDoc]
* {ProductShortName} Knowledgebase articles on the Red Hat Customer Portal
** https://access.redhat.com/taxonomy/tags/windup[All {ProductShortName} articles]
Expand Down
6 changes: 0 additions & 6 deletions docs/topics/Rules-Create-Your-First-Rule.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,12 +194,6 @@ For Linux or Mac: ~/.windup/rules/
For Windows: "\Documents and Settings\USER_NAME\.windup\rules\" or "\Users\USER_NAME\.windup\rules\"
----

[discrete]
==== Validate the Rule Against the Schema

To validate your XML rule using the {ProductShortName} rule schema, see xref:Rules-Validate-Rulesets-Against-the-Schema[Validate Rulesets Against the Schema].


[discrete]
==== Test the Rule

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/Rules-Development-Guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you would like to contribute to the {ProductName} source code base or provide
* xref:Rules-Create-a-Basic-XML-Rule[Create a Basic XML Rule]
* xref:Rules-XML-Rule-When-Condition-Syntax[XML Rule - When Condition Syntax]
* xref:Rules-XML-Rule-Perform-Action-Syntax[XML Rule - Perform Action Syntax]
* xref:Rules-Validate-Rulesets-Against-the-Schema[Validate Rulesets Against the Schema]
//* xref:Rules-Validate-Rulesets-Against-the-Schema[Validate Rulesets Against the Schema]
* xref:Rules-Test-a-Basic-XML-Rule[Test an XML Rule in {ProductName}]
* xref:Rules-Override-Rules[Overriding Rules]

Expand Down
25 changes: 9 additions & 16 deletions docs/topics/Rules-Important-Links.adoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@







[[Rules-Important-Links]]
=== Important Links

* {ProductName} wiki: https://github.com/windup/windup/wiki
* {ProductShortName} documentation (generated from the Wiki documentation at the link above):
** {ProductDocUserGuideURL}[{ProductShortName} User Guide]
** {ProductDocRulesGuideURL}[{ProductShortName} Rules Development Guide]
** {ProductDocCoreGuideURL}[{ProductShortName} Core Development Guide]
** http://windup.github.io/windup/docs/latest/javadoc[{ProductShortName} Javadoc]
* {ProductShortName} Javadoc: http://windup.github.io/windup/docs/latest/javadoc
* {ProductShortName} forums: https://developer.jboss.org/en/windup
* {ProductShortName} issue tracker: https://issues.jboss.org/browse/WINDUP
* {ProductShortName} users mailing List: [email protected]
* {ProductShortName} developers mailing list: [email protected]
* {ProductShortName} commits mailing list: [email protected]
* {ProductShortName} JIRA issue trackers
** Core Windup: https://issues.jboss.org/browse/WINDUP
** Windup Rules: https://issues.jboss.org/browse/WINDUPRULE
* Windup Mailing Lists
** Windup Users: [email protected]
** Windup Developers: [email protected]
** Windup Commits: [email protected]
* {ProductShortName} on Twitter: https://twitter.com/jbosswindup[@JBossWindup]
* {ProductShortName} IRC channel: Server FreeNode (`irc.freenode.net`), channel `#windup`.
** http://transcripts.jboss.org/channel/irc.freenode.org/%23windup/index.html[{ProductShortName} IRC Chat transcripts]
** http://transcripts.jboss.org/meeting/irc.freenode.org/windup/index.html[{ProductShortName} meeting IRC Chat transcripts]
* {ProductShortName} IRC channel: Server FreeNode (`irc.freenode.net`), channel `#windup` (http://transcripts.jboss.org/channel/irc.freenode.org/%23windup/index.html[transcripts])
2 changes: 1 addition & 1 deletion docs/topics/Rules-Review-the-Existing-XML-Rules.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@



[Review-the-Existing-XML-Rules]
[[Review-the-Existing-XML-Rules]]
=== Review the Existing {ProductShortName} XML Rules

{ProductShortName} XML-based rules are located on GitHub at the following location: https://github.com/windup/windup-rulesets/tree/master/rules.
Expand Down
5 changes: 2 additions & 3 deletions docs/topics/Rules-Validate-Rulesets-Against-the-Schema.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ To validate XML rules using the {ProductShortName} rule schema, follow these ste

. Download this XML validator: https://github.com/amouat/xsd-validator/releases/download/v1.0/xsdv-1.0.zip
. Extract the ZIP file into a directory of your choice.
. The xsd-validator requires the schema file to be located on the local file system. Download the {ProductShortName} rule schema from one of the following locations to a directory of your choice.
* http://windup.jboss.org/schema/windup-jboss-ruleset.xsd
* https://github.com/windup/windup/blob/master/config-xml/windup-jboss-ruleset.xsd
. The xsd-validator requires the schema file to be located on the local file system. Download the {ProductShortName} rule schema from the following location to a directory of your choice.
** http://windup.jboss.org/schema/windup-jboss-ruleset.xsd
. Run the following command, replacing the variables as follows.
* RULESET_DIRECTORY: The path to the top level folder that contains the rules.
* XSD_VALIDATOR: The path to the extracted xsd-validator.
Expand Down
2 changes: 2 additions & 0 deletions docs/topics/_Sidebar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ https://github.com/windup/windup-quickstarts/releases[{ProductShortName} Quickst
https://access.redhat.com/documentation/en/red-hat-jboss-migration-toolkit/{ProductDocVersion}/windup-user-guide[{ProductName} User Guide] +
https://access.redhat.com/documentation/en/red-hat-jboss-migration-toolkit/{ProductDocVersion}/windup-rules-development-guide[{ProductName} Rules Development Guide] +

////
=== Unpublished Pre-Release Preview of the Guides
http://windup.github.io/windup/docs/latest/html/WindupUserGuide.html[{ProductName} User Guide (HTML)] +
http://windup.github.io/windup/docs/latest/html/WindupRulesDevelopmentGuide.html[{ProductName} Rules Development Guide (HTML)] +
http://windup.github.io/windup/docs/latest/html/WindupCoreDevelopmentGuide.html[{ProductName} Core Development Guide (HTML)] +
////

=== Wiki Guides:

Expand Down
4 changes: 2 additions & 2 deletions wiki-docs/Get-Involved.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:ProductName: Windup
:ProductShortName: Windup
:ProductDocRulesGuideURL: http://windup.github.io/windup/docs/latest/html/WindupRulesDevelopmentGuide.html
:ProductDocCoreGuideURL: http://windup.github.io/windup/docs/latest/html/WindupCoreDevelopmentGuide.html
:ProductDocRulesGuideURL: https://github.com/windup/windup/wiki/Rules-Development-Guide
:ProductDocCoreGuideURL: https://github.com/windup/windup/wiki/Core-Development-Guide

[[Get-Involved]]
=== Get Involved
Expand Down
11 changes: 5 additions & 6 deletions wiki-docs/Home.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
:ProductName: Windup
:ProductShortName: Windup
////
:ProductDocUserGuideURL: http://windup.github.io/windup/docs/latest/html/WindupUserGuide.html
:ProductDocRulesGuideURL: http://windup.github.io/windup/docs/latest/html/WindupRulesDevelopmentGuide.html
:ProductDocCoreGuideURL: http://windup.github.io/windup/docs/latest/html/WindupCoreDevelopmentGuide.html
////

= Welcome to {ProductName}

Expand Down Expand Up @@ -31,17 +33,14 @@ https://github.com/windup/windup-legacy[windup-legacy] GitHub repository.
{ProductName} documentation is organized into guides that target specific audiences.

* link:./User-Guide[{ProductName} User Guide] is for engineers, consultants, or others who plan to use
{ProductName} to migrate applications or other components. For a single page HTML version, see the {ProductDocUserGuideURL}[{ProductName} User Guide single HTML].
* link:./Rules-Development-Guide[{ProductName} Rules Development Guide] provides details for developers, consultants, and others who plan to create custom rule add-ons for the {ProductName} project. For a single page HTML version, see the {ProductDocRulesGuideURL}[{ProductName} Rules Development Guide single HTML].
* link:./Core-Development-Guide[{ProductName} Core Development Guide] provides information for developers who plan to contribute source code updates or core rule add-ons to the {ProductName} project. For a single page HTML version, see the {ProductDocCoreGuideURL}[{ProductName} Core Development Guide single HTML].
{ProductName} to migrate applications or other components.
* link:./Rules-Development-Guide[{ProductName} Rules Development Guide] provides details for developers, consultants, and others who plan to create custom rule add-ons for the {ProductName} project.
* link:./Core-Development-Guide[{ProductName} Core Development Guide] provides information for developers who plan to contribute source code updates or core rule add-ons to the {ProductName} project.
* link:./Migration-Planning-Guide[Migration Planning Guide] is for developers, Project Managers, or IT managers who must interpret the {ProductShortName} reports and develop a project plan.

== Additional Resources

* {ProductShortName} Documentation
** {ProductDocUserGuideURL}[{ProductName} User Guide]
** {ProductDocRulesGuideURL}[{ProductName} Rules Development Guide]
** {ProductDocCoreGuideURL}[{ProductName} Core Development Guide]
** http://windup.github.io/windup/docs/latest/javadoc[{ProductName} JavaDoc]
* {ProductShortName} Knowledgebase articles on the Red Hat Customer Portal
** https://access.redhat.com/taxonomy/tags/windup[All {ProductShortName} articles]
Expand Down
6 changes: 0 additions & 6 deletions wiki-docs/Rules-Create-Your-First-Rule.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,12 +194,6 @@ For Linux or Mac: ~/.windup/rules/
For Windows: "\Documents and Settings\USER_NAME\.windup\rules\" or "\Users\USER_NAME\.windup\rules\"
----

[discrete]
==== Validate the Rule Against the Schema

To validate your XML rule using the {ProductShortName} rule schema, see link:Rules-Validate-Rulesets-Against-the-Schema[Validate Rulesets Against the Schema].


[discrete]
==== Test the Rule

Expand Down
2 changes: 1 addition & 1 deletion wiki-docs/Rules-Development-Guide.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you would like to contribute to the {ProductName} source code base or provide
* link:Rules-Create-a-Basic-XML-Rule[Create a Basic XML Rule]
* link:Rules-XML-Rule-When-Condition-Syntax[XML Rule - When Condition Syntax]
* link:Rules-XML-Rule-Perform-Action-Syntax[XML Rule - Perform Action Syntax]
* link:Rules-Validate-Rulesets-Against-the-Schema[Validate Rulesets Against the Schema]
//* link:Rules-Validate-Rulesets-Against-the-Schema[Validate Rulesets Against the Schema]
* link:Rules-Test-a-Basic-XML-Rule[Test an XML Rule in {ProductName}]
* link:Rules-Override-Rules[Overriding Rules]

Expand Down
25 changes: 9 additions & 16 deletions wiki-docs/Rules-Important-Links.asciidoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
:ProductName: Windup
:ProductShortName: Windup
:ProductDocUserGuideURL: http://windup.github.io/windup/docs/latest/html/WindupUserGuide.html
:ProductDocRulesGuideURL: http://windup.github.io/windup/docs/latest/html/WindupRulesDevelopmentGuide.html
:ProductDocCoreGuideURL: http://windup.github.io/windup/docs/latest/html/WindupCoreDevelopmentGuide.html


[[Rules-Important-Links]]
=== Important Links

* {ProductName} wiki: https://github.com/windup/windup/wiki
* {ProductShortName} documentation (generated from the Wiki documentation at the link above):
** {ProductDocUserGuideURL}[{ProductShortName} User Guide]
** {ProductDocRulesGuideURL}[{ProductShortName} Rules Development Guide]
** {ProductDocCoreGuideURL}[{ProductShortName} Core Development Guide]
** http://windup.github.io/windup/docs/latest/javadoc[{ProductShortName} Javadoc]
* {ProductShortName} Javadoc: http://windup.github.io/windup/docs/latest/javadoc
* {ProductShortName} forums: https://developer.jboss.org/en/windup
* {ProductShortName} issue tracker: https://issues.jboss.org/browse/WINDUP
* {ProductShortName} users mailing List: [email protected]
* {ProductShortName} developers mailing list: [email protected]
* {ProductShortName} commits mailing list: [email protected]
* {ProductShortName} JIRA issue trackers
** Core Windup: https://issues.jboss.org/browse/WINDUP
** Windup Rules: https://issues.jboss.org/browse/WINDUPRULE
* Windup Mailing Lists
** Windup Users: [email protected]
** Windup Developers: [email protected]
** Windup Commits: [email protected]
* {ProductShortName} on Twitter: https://twitter.com/jbosswindup[@JBossWindup]
* {ProductShortName} IRC channel: Server FreeNode (`irc.freenode.net`), channel `#windup`.
** http://transcripts.jboss.org/channel/irc.freenode.org/%23windup/index.html[{ProductShortName} IRC Chat transcripts]
** http://transcripts.jboss.org/meeting/irc.freenode.org/windup/index.html[{ProductShortName} meeting IRC Chat transcripts]
* {ProductShortName} IRC channel: Server FreeNode (`irc.freenode.net`), channel `#windup` (http://transcripts.jboss.org/channel/irc.freenode.org/%23windup/index.html[transcripts])
2 changes: 1 addition & 1 deletion wiki-docs/Rules-Review-the-Existing-XML-Rules.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:ProductName: Windup
:ProductShortName: Windup

[Review-the-Existing-XML-Rules]
[[Review-the-Existing-XML-Rules]]
=== Review the Existing {ProductShortName} XML Rules

{ProductShortName} XML-based rules are located on GitHub at the following location: https://github.com/windup/windup-rulesets/tree/master/rules.
Expand Down
5 changes: 2 additions & 3 deletions wiki-docs/Rules-Validate-Rulesets-Against-the-Schema.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ To validate XML rules using the {ProductShortName} rule schema, follow these ste

. Download this XML validator: https://github.com/amouat/xsd-validator/releases/download/v1.0/xsdv-1.0.zip
. Extract the ZIP file into a directory of your choice.
. The xsd-validator requires the schema file to be located on the local file system. Download the {ProductShortName} rule schema from one of the following locations to a directory of your choice.
* http://windup.jboss.org/schema/windup-jboss-ruleset.xsd
* https://github.com/windup/windup/blob/master/config-xml/windup-jboss-ruleset.xsd
. The xsd-validator requires the schema file to be located on the local file system. Download the {ProductShortName} rule schema from the following location to a directory of your choice.
** http://windup.jboss.org/schema/windup-jboss-ruleset.xsd
. Run the following command, replacing the variables as follows.
* RULESET_DIRECTORY: The path to the top level folder that contains the rules.
* XSD_VALIDATOR: The path to the extracted xsd-validator.
Expand Down
2 changes: 2 additions & 0 deletions wiki-docs/_Sidebar.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ https://github.com/windup/windup-quickstarts/releases[{ProductShortName} Quickst
https://access.redhat.com/documentation/en/red-hat-jboss-migration-toolkit/{ProductDocVersion}/windup-user-guide[{ProductName} User Guide] +
https://access.redhat.com/documentation/en/red-hat-jboss-migration-toolkit/{ProductDocVersion}/windup-rules-development-guide[{ProductName} Rules Development Guide] +

////
=== Unpublished Pre-Release Preview of the Guides
http://windup.github.io/windup/docs/latest/html/WindupUserGuide.html[{ProductName} User Guide (HTML)] +
http://windup.github.io/windup/docs/latest/html/WindupRulesDevelopmentGuide.html[{ProductName} Rules Development Guide (HTML)] +
http://windup.github.io/windup/docs/latest/html/WindupCoreDevelopmentGuide.html[{ProductName} Core Development Guide (HTML)] +
////

=== Wiki Guides:

Expand Down

0 comments on commit 150cdbf

Please sign in to comment.