From 9aae65cce0dc5ad4a688b26b8b12b93dc54ed613 Mon Sep 17 00:00:00 2001 From: Andrea Hoffer Date: Tue, 10 May 2016 12:08:08 -0400 Subject: [PATCH] Updates for the 2.5.0.Final build --- docs/topics/Get-Involved.adoc | 2 -- docs/topics/Home.adoc | 11 ++++---- docs/topics/Rules-Create-Your-First-Rule.adoc | 6 ----- docs/topics/Rules-Development-Guide.adoc | 2 +- docs/topics/Rules-Important-Links.adoc | 25 +++++++------------ .../Rules-Review-the-Existing-XML-Rules.adoc | 2 +- ...-Validate-Rulesets-Against-the-Schema.adoc | 5 ++-- docs/topics/_Sidebar.adoc | 2 ++ wiki-docs/Get-Involved.asciidoc | 4 +-- wiki-docs/Home.asciidoc | 11 ++++---- .../Rules-Create-Your-First-Rule.asciidoc | 6 ----- wiki-docs/Rules-Development-Guide.asciidoc | 2 +- wiki-docs/Rules-Important-Links.asciidoc | 25 +++++++------------ ...les-Review-the-Existing-XML-Rules.asciidoc | 2 +- ...idate-Rulesets-Against-the-Schema.asciidoc | 5 ++-- wiki-docs/_Sidebar.asciidoc | 2 ++ 16 files changed, 42 insertions(+), 70 deletions(-) diff --git a/docs/topics/Get-Involved.adoc b/docs/topics/Get-Involved.adoc index 87050e768f..85f9f4bc8d 100644 --- a/docs/topics/Get-Involved.adoc +++ b/docs/topics/Get-Involved.adoc @@ -1,8 +1,6 @@ - - [[Get-Involved]] === Get Involved diff --git a/docs/topics/Home.adoc b/docs/topics/Home.adoc index b84447cbd5..a45300935a 100644 --- a/docs/topics/Home.adoc +++ b/docs/topics/Home.adoc @@ -1,8 +1,10 @@ +//// +//// = Welcome to {ProductName} @@ -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] diff --git a/docs/topics/Rules-Create-Your-First-Rule.adoc b/docs/topics/Rules-Create-Your-First-Rule.adoc index 0b6406ad40..575b963f17 100644 --- a/docs/topics/Rules-Create-Your-First-Rule.adoc +++ b/docs/topics/Rules-Create-Your-First-Rule.adoc @@ -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 diff --git a/docs/topics/Rules-Development-Guide.adoc b/docs/topics/Rules-Development-Guide.adoc index d086b8ff4d..6017b22fdc 100644 --- a/docs/topics/Rules-Development-Guide.adoc +++ b/docs/topics/Rules-Development-Guide.adoc @@ -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] diff --git a/docs/topics/Rules-Important-Links.adoc b/docs/topics/Rules-Important-Links.adoc index 7de6f9fb3b..467edac229 100644 --- a/docs/topics/Rules-Important-Links.adoc +++ b/docs/topics/Rules-Important-Links.adoc @@ -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: windup-users@lists.jboss.org -* {ProductShortName} developers mailing list: windup-dev@lists.jboss.org -* {ProductShortName} commits mailing list: windup-commits@lists.jboss.org +* {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: windup-users@lists.jboss.org +** Windup Developers: windup-dev@lists.jboss.org +** Windup Commits: windup-commits@lists.jboss.org * {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]) diff --git a/docs/topics/Rules-Review-the-Existing-XML-Rules.adoc b/docs/topics/Rules-Review-the-Existing-XML-Rules.adoc index 7fd1459398..717884c150 100644 --- a/docs/topics/Rules-Review-the-Existing-XML-Rules.adoc +++ b/docs/topics/Rules-Review-the-Existing-XML-Rules.adoc @@ -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. diff --git a/docs/topics/Rules-Validate-Rulesets-Against-the-Schema.adoc b/docs/topics/Rules-Validate-Rulesets-Against-the-Schema.adoc index aa54556362..cabe93ea6e 100644 --- a/docs/topics/Rules-Validate-Rulesets-Against-the-Schema.adoc +++ b/docs/topics/Rules-Validate-Rulesets-Against-the-Schema.adoc @@ -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. diff --git a/docs/topics/_Sidebar.adoc b/docs/topics/_Sidebar.adoc index 4aa38431ce..4323fe00cc 100644 --- a/docs/topics/_Sidebar.adoc +++ b/docs/topics/_Sidebar.adoc @@ -14,6 +14,7 @@ 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)] + @@ -21,6 +22,7 @@ http://windup.github.io/windup/docs/latest/html/WindupUserGuide.html[{ProductNam 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: diff --git a/wiki-docs/Get-Involved.asciidoc b/wiki-docs/Get-Involved.asciidoc index b765fc0b77..822ef3b014 100644 --- a/wiki-docs/Get-Involved.asciidoc +++ b/wiki-docs/Get-Involved.asciidoc @@ -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 diff --git a/wiki-docs/Home.asciidoc b/wiki-docs/Home.asciidoc index 4cd025a720..4aacc878cd 100644 --- a/wiki-docs/Home.asciidoc +++ b/wiki-docs/Home.asciidoc @@ -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} @@ -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] diff --git a/wiki-docs/Rules-Create-Your-First-Rule.asciidoc b/wiki-docs/Rules-Create-Your-First-Rule.asciidoc index 41132ca7f2..d51c62a4fa 100644 --- a/wiki-docs/Rules-Create-Your-First-Rule.asciidoc +++ b/wiki-docs/Rules-Create-Your-First-Rule.asciidoc @@ -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 diff --git a/wiki-docs/Rules-Development-Guide.asciidoc b/wiki-docs/Rules-Development-Guide.asciidoc index 72dc4edb6f..e02e104916 100644 --- a/wiki-docs/Rules-Development-Guide.asciidoc +++ b/wiki-docs/Rules-Development-Guide.asciidoc @@ -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] diff --git a/wiki-docs/Rules-Important-Links.asciidoc b/wiki-docs/Rules-Important-Links.asciidoc index c6038d2d83..585d740920 100644 --- a/wiki-docs/Rules-Important-Links.asciidoc +++ b/wiki-docs/Rules-Important-Links.asciidoc @@ -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: windup-users@lists.jboss.org -* {ProductShortName} developers mailing list: windup-dev@lists.jboss.org -* {ProductShortName} commits mailing list: windup-commits@lists.jboss.org +* {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: windup-users@lists.jboss.org +** Windup Developers: windup-dev@lists.jboss.org +** Windup Commits: windup-commits@lists.jboss.org * {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]) diff --git a/wiki-docs/Rules-Review-the-Existing-XML-Rules.asciidoc b/wiki-docs/Rules-Review-the-Existing-XML-Rules.asciidoc index 077dda4fac..fa7bd6fd7e 100644 --- a/wiki-docs/Rules-Review-the-Existing-XML-Rules.asciidoc +++ b/wiki-docs/Rules-Review-the-Existing-XML-Rules.asciidoc @@ -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. diff --git a/wiki-docs/Rules-Validate-Rulesets-Against-the-Schema.asciidoc b/wiki-docs/Rules-Validate-Rulesets-Against-the-Schema.asciidoc index c0c3ecc87c..3fc9ff92b0 100644 --- a/wiki-docs/Rules-Validate-Rulesets-Against-the-Schema.asciidoc +++ b/wiki-docs/Rules-Validate-Rulesets-Against-the-Schema.asciidoc @@ -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. diff --git a/wiki-docs/_Sidebar.asciidoc b/wiki-docs/_Sidebar.asciidoc index f0743664f0..cecabdd733 100644 --- a/wiki-docs/_Sidebar.asciidoc +++ b/wiki-docs/_Sidebar.asciidoc @@ -14,6 +14,7 @@ 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)] + @@ -21,6 +22,7 @@ http://windup.github.io/windup/docs/latest/html/WindupUserGuide.html[{ProductNam 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: