windup · sgilda · Dec 19, 2014 · Dec 19, 2014
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
@@ -78,9 +78,9 @@ cp ../windup.wiki/What-is-Windup.asciidoc docs/What-is-Windup.adoc
 grep 'xref:[a-z]' `find . -name '*.adoc'`
 ----
 
-** Finds and lists pages containing `link:` macros to other pages. These pages must be added to the book.
+** Finds and lists pages containing `xref:` macros to other pages. These pages must be added to the book.
 
-** Replaces the `link:` macros with a `xref:` macros.
+** Replaces the `xref:` macros with a `xref:` macros.
 +
 ----
 asciidoctor -dbook -a toc -o html/WindupUserGuide.html docs/Windup-User-Guide.adoc

diff --git a/README.adoc b/README.adoc
@@ -1,7 +1,90 @@
 =  Windup 2.0 Product Documentation
 
-Windup project documentation is created collaboratively on the Windup project Wiki site located here: <https://github.com/windup/windup/wiki>. 
+== Overview
 
+Windup project documentation is created collaboratively on the Windup project Wiki site located here: <https://github.com/windup/windup/wiki>. 
 This `windup-documentation` repository takes documentation from that site, makes minor modifications, and publishes the pages in single HTML page book format. 
+This repository will contain the source for the official documentation when the Windup 2.0 ships.
+
+== Procedure to Copy and Modify the Wiki Documentation
+
+Run the scripts/windupDocUpdate.sh script to copy and modify the files. 
+
+. Copies the `.asciidoc` files to the `docs/` directory and renames them with the `.adoc` extension.
+. Replaces the `xref:` macros to other pages with `xref:` macros.
+. Uses AsciiDoctor to create the guides in the `html/` directory.
+
+== Procedure to Publish the Guides
+
+* The first time, you must fork and clone the windup GitHub repository. After that, just fetch the latest upstream.
++
+----
+git clone https://github.com/windup/windup.git
+git fetch upstream
+----
+
+* The first time, you must fork and clone the windup-documentation GitHub repository. After that, just fetch the latest upstream.
++
+----
+git clone https://github.com/windup/windup-documentation.git
+git fetch upstream
+----
+
+* Navigate to the local windup directory.
++
+----
+cd windup
+----
+
+* Checkout the gh-pages from the windup repository
++
+----
+git checkout -b gh-pages windup
+----
+
+* If the directory does not yet exist, create a docs/WINDUP-RELEASE-html/ directory.
++
+----
+mkdir -p docs/2.0.0.Beta6/html (if it doesn't exist!)
+----
+
+* Copy any new images, stylesheets, and html files from windup-documentation:
++
+----
+cp ../windup-documentation/html/*.html ../windup-documentation/*.css ../windup-documentation/images/* docs/2.0.0.Beta6/html
+----
+
+* Add the updated files to GitHub.
++
+----
+git add docs
+----
+
+* Commit the changes.
++
+----
+git commit -m "Update message..."
+----
+
+* Push the changes to GitHub.
++
+----
+git push upstream gh-pages
+----
+
+== Access the Guides
+
+View the documentation at the following URLs.
+
+[cols="2*"]
+|===
+| **Guide** | **URL**
+| Windup User Guide | http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupUserGuide.html
+| Windup Rules Development Guide | http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupRulesDevelopmentGuide.html
+| Windup Core Development Guide | http://windup.github.io/windup/docs/2.0.0.Beta6/html/WindupCoreDevelopmentGuide.html
+| Windup Migration Planning Guide | TBD
+|===
+
+
+
 
-This repository will contain the official documentation when the Windup 2.0 ships.
diff --git a/docs/About-the-Windup-Wiki.adoc b/docs/About-the-Windup-Wiki.adoc
@@ -0,0 +1,48 @@
+[[About-the-Windup-Wiki]]
+=== About the Windup Wiki
+
+==== Purpose
+
+This wiki is a place to create Windup documentation in a collaborative manner, a bit wildly, and on the fly. It is intended to reflect the state of the Windup source code master branch, however pages may become obsolete as the master changes quickly.
+
+==== Areas of Interest
+
+The Wiki pages are divided into the following main areas of interest, which may often overlap. The page names use these prefixes:
+
+* *Dev-: ...*: These pages are of interest to Windup core developers.
+* *Rules- ...*: These pages are of interest to rules developers.
+* *User- ...*: These pages that are of interest to Windup users.
+* no prefix: These pages that are also of interest to Windup users.
+
+==== Markdown, AsciiDoc, or...?
+
+This Wiki uses AsciiDoc because it is capable of handling the publishing requirements and structural elements needed to create technical books. If you would like to contribute to the documentation, feel free to use your favorite Wiki language, however, it will ultimately be converted to AsciiDoc.
+
+==== Contributor Guidelines
+
+Please see the https://github.com/windup/windup-documentation/blob/master/CONTRIBUTING.adoc[Contributing Guidelines] for details about how to name pages and use the correct AsciiDoc syntax to make the transition to the final documentation go more smoothly. 
+
+The following is a brief overview.
+
+* Name wiki pages using only letters, numbers and dashes. Do not include spaces, colons, or other special characters in page names.
+
+* Be sure to add a level 3 page heading (===) at the top of each page. When compiled in a book, the Guide name is the top level, chapters are level 2, and the page is level  3. This is the title that appears in the table of contents for the page.
+
+        === Build Windup from Source
+
+* At the beginning of each new Wiki page, add an anchor with the exact page name, including the dashes. This generates the correct anchors that are needed when the pages are combined into a book.
+
+        [[Dev-Build-Windup-from-Source]]
+        === Build Windup from Source
+
+*   Wiki generates anchors using dashes for spaces. AsciiDoctor generates a leading underscore and underscores for spaces.When referring to another section within the same page, do not use the `<<section-title-anchor>>` syntax. Instead, create an anchor and use the 'xref:' syntax to provide the link. Replace spaces in the section title with dashes.
+
+    Create the anchor at the top of the section using double brackets to force the generation of dashes instead of underscores.
+
+        [[windup-command-examples]]
+        ==== Windup Command Examples
+
+    Then use the `xref` to create the link.
+
+        See xref:windup-command-examples[Windup Command Examples] for more information.
+
diff --git a/docs/Core-Development-Guide.asciidoc b/docs/Core-Development-Guide.asciidoc
@@ -1,48 +1,46 @@
-= Windup Core Development Guide
+[[Core-Development-Guide]]
+=== Windup Core Development Guide
 
 This guide is for developers who plan to contribute source code updates
 or core rule add-ons to the Windup 2.0 project.
 
-== Overview
+==== Overview
 
 * link:What-is-Windup[What is Windup]?
 * link:Features-of-Windup-2.0[Features of Windup 2.0]
 * link:Get-Involved[Get Involved] - We need your feedback!
 * link:Dev-Windup-Project-Information[Windup Project Information] - Github
 repository, IRC, Mailing lists, ...
-* link:Dev-Create-JavaDoc-for-Windup[Create JavaDoc for Windup]
 * link:Report-Issues-with-Windup[Report Issues with Windup
 * link:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]
 
-== Get Started
+==== Get Started
 * link:Install-and-Configure-Maven[Install and Configure Maven]
 * link:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code]
 * link:Dev-Build-Windup-from-Source[Build Windup from Source]
 * link:Dev-Execute-Windup-Built-from-Source[Execute Windup Built from Source]
 * link:Review-the-Report[Review the Report]
 * link:Glossary[Glossary of Terms]
 
-== Developer Contributing Information
+==== Developer Contributing Information
 
 * link:Dev-Development-Guidelines[Developer Guidelines]
 * link:Dev-Submit-Code-Updates-to-the-Windup-Project[Submit Code Updates to the Windup Project]
 
-== Understand the Windup Architecture and Structure
+==== Understand the Windup Architecture and Structure
 
 * link:Dev-Windup-Architectural-Components[Windup Architectural Components]
 * link:Dev-Windup-Project-Structure[Windup Project Structure]
 
-== Rules and Rulesets
+==== Rules and Rulesets
 
 
-== Debugging and Troubleshooting
+==== Debugging and Troubleshooting
 
 * link:Dev-Debugging-and-Profiling[Debugging and Profiling]
 * link:Dev-Troubleshooting[Troubleshooting]
 
-== Miscellaneous Pages
-
-=== Developer topics
+==== Developer topics
 
 * link:Dev-Windup-Bootstrap[Bootstrap]
 * link:Dev-Classloading-Notes[Classloading Notes]
@@ -56,7 +54,7 @@ repository, IRC, Mailing lists, ...
 * link:Dev-Port-WindRide-Functionality-to-Windup[Port WindRide Functionality to Windup]
 * link:Dev-Git-Rebasing[Git Rebasing]
 
-=== Rules topics
+==== Rules topics
 
 * link:Rules-Available-Rules-Utilities[Available Utilities]
 * link:Dev-Concepts-and-Philosophy[Concepts and Philosophy]
@@ -80,3 +78,10 @@ repository, IRC, Mailing lists, ...
 * link:Rules-Java-based-Rule-Structure[Java-Based Rule Structure]
 * link:Rules-Rule-Story-Points[Rule Story Points]
 
+==== Wiki and Product Documentation
+
+* link:About-the-Windup-Wiki[About the Windup Wiki]
+* link:Dev-Add-Images-to-the-Windup-Wiki[Add Images to the Windup Wiki]
+* link:Dev-Create-Windup-JavaDoc[Create Windup JavaDoc]
+* link:Dev-Windup-Documentation-Process[Windup Documentation Process]
+
diff --git a/docs/Dev-Add-Images-to-the-Windup-Wiki.adoc b/docs/Dev-Add-Images-to-the-Windup-Wiki.adoc
@@ -0,0 +1,48 @@
+[[Dev-Add-Images-to-the-Windup-Wiki]]
+=== Add Images to the Windup Wiki
+
+* Fork https://github.com/windup/windup/wiki
+* Clone the Windup Wiki into a `windup.wiki/` directory using the SSH clone URL: 
+
+         git clone git@github.com:USER_NAME/windup.git windup.wiki
+
+* Navigate to the new `windup.wiki/` directory.
+
+* Add the upstream repository.
+
+        git remote add -f upstream git@github.com:windup/windup.wiki.git
+
+* Check out a branch to work in.
+
+        git checkout -b BRANCH_NAME upstream/master
+
+* Copy the image into the `windup.wiki/images` directory
+
+        cp IMAGE_NAME.png images/
+
+* Add the new image to Git
+
+        git add images/IMAGE_NAME.png
+
+* Commit the change
+
+        git commit -m "Add new image"
+
+* Push the change to your Windup Wiki repository.
+
+        git push origin HEAD:master
+
+* Test the new image in a page on your own Wiki.
+
+        image:images/IMAGE_NAME.png[New Image]
+
++ 
+For example:
+
++
+image:images/windup-logo-large.png[Windup Logo]
+
+* If it works, push the image to the upstream repository
+
+        git push upstream HEAD:master
+
diff --git a/docs/Dev-Classloading-Notes.adoc b/docs/Dev-Classloading-Notes.adoc
@@ -1,6 +1,9 @@
+[[Dev-Classloading-Notes]]
 === Classloading Notes
 
-DRAFT - _Page contains temporary notes, to be edited._
+.DRAFT
+
+_Page contains temporary notes, to be edited._
 
 This covers the specific situations when the Windup core developer needs to look up certain runtime classes. Does not relate to rules authoring.
 

diff --git a/docs/Dev-Concepts-and-Philosophy.adoc b/docs/Dev-Concepts-and-Philosophy.adoc
@@ -1,7 +1,8 @@
-_TODO - OZIZKA: Can this topic be marked obsolete and be replaced by this one: xref:Windup-Processing-Overview[Windup Processing Overview] ?_
-
+[[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] ?_
+
 Windup is a rule-based tool that allows users to write customized rules
 based on the needs, constructs, and custom APIs used in their
 applications.

diff --git a/docs/Dev-Connect-to-the-Graph-via-Rexster.adoc b/docs/Dev-Connect-to-the-Graph-via-Rexster.adoc
@@ -1,3 +1,4 @@
+[[Dev-Connect-to-the-Graph-via-Rexster]]
 === Connect to the Graph via Rexster
 
 There is a specific addon for running Rexster along your graph with 

diff --git a/docs/Dev-Create-JavaDoc-for-Windup.adoc → docs/Dev-Create-Windup-JavaDoc.adoc b/docs/Dev-Create-JavaDoc-for-Windup.adoc → docs/Dev-Create-Windup-JavaDoc.adoc
@@ -1,12 +1,15 @@
-=== Create JavaDoc for Windup
-
-Use the following procedure to create JavaDoc for Windup.
-
-. In Windup project root directory, type the following Maven command:
-+
------------------------------------
-mvn validate -PjavadocDist
------------------------------------
-. The JavaDoc is created in the Windup `target/site/apidocs` subdirectory.
-
+[[Dev-Create-Windup-JavaDoc]]
+=== Create Windup JavaDoc
+
+The most recent Windup JavaDoc build is located here: http://windup.github.io/windup/docs/javadoc/latest/index.html
+
+If you want to build an updated version, use the following procedure to create JavaDoc for Windup.
+
+. In Windup project root directory, type the following Maven command:
++
+-----------------------------------
+mvn validate -PjavadocDist
+-----------------------------------
+. The JavaDoc is created in the Windup `target/site/apidocs` subdirectory.
+
 NOTE: To cross-link with 3rd-party libraries, see https://issues.jboss.org/browse/WINDUP-422[WINDUP-422} and http://stackoverflow.com/questions/27392535/javadoc-how-to-make-it-link-the-dependencies-maven-project.
diff --git a/docs/Dev-Decompiling.adoc b/docs/Dev-Decompiling.adoc
@@ -1,6 +1,7 @@
+[[Dev-Decompiling]]
 === Decompiling
 
-DRAFT: 
+.DRAFT
 
 ==== The *Decompiler* API
 

diff --git a/docs/Dev-Dependencies.adoc b/docs/Dev-Dependencies.adoc
@@ -1,7 +1,9 @@
 [[Dev-Dependencies]]
 === Dependencies (Forge add-ons)
 
-DRAFT _Based on 
+.DRAFT 
+
+_Based on 
 https://github.com/OndraZizka/windup/commit/3574e81900cbad2b3a83d0bd6c263eb22c48e55e[this]
 discussion._
 

diff --git a/docs/Dev-Development-Guidelines.adoc b/docs/Dev-Development-Guidelines.adoc
@@ -1,3 +1,4 @@
+[[Dev-Development-Guidelines]]
 === Development Guidelines
 
 ==== Project Source Code Format

diff --git a/docs/Dev-Frames-Extensions.adoc b/docs/Dev-Frames-Extensions.adoc
@@ -1,3 +1,4 @@
+[[Dev-Frames-Extensions]]
 === Frames Extensions
 
 Windup has several Frames extensions to satisfy its needs.

diff --git a/docs/Dev-Get-the-Windup-Source-Code.adoc b/docs/Dev-Get-the-Windup-Source-Code.adoc
@@ -1,3 +1,4 @@
+[[Dev-Get-the-Windup-Source-Code]]
 === Get the Windup Source Code
 
 To contribute to the Windup 2.0 project source code, you must fork the Windup repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests back to the Windup repository.

diff --git a/docs/Dev-Git-Rebasing.adoc b/docs/Dev-Git-Rebasing.adoc
@@ -1,3 +1,4 @@
+[[Dev-Git-Rebasing]]
 === Git Rebasing
 
 Ondra Zizka wrote this simple script to bring down a series of pull requests into a

diff --git a/docs/Dev-Internal-API-Features.adoc b/docs/Dev-Internal-API-Features.adoc
@@ -1,3 +1,4 @@
+[[Dev-Internal-API-Features]]
 === Internal API Features
 
 ==== Find the RuleProvider that provided a Rule

diff --git a/docs/Dev-Logging.adoc b/docs/Dev-Logging.adoc
@@ -1,3 +1,4 @@
+[[Dev-Logging]]
 === Logging
 
 .DRAFT

diff --git a/docs/Dev-Port-WindRide-Functionality-to-Windup.adoc b/docs/Dev-Port-WindRide-Functionality-to-Windup.adoc
@@ -1,3 +1,4 @@
+[[Dev-Port-WindRide-Functionality-to-Windup]]
 === Port WindRide Functionality to Windup
 
 _For the purposes of tracking the porting WindRide functionality to Windup. Will be

diff --git a/docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc b/docs/Dev-Submit-Code-Updates-to-the-Windup-Project.adoc
@@ -1,3 +1,4 @@
+[[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.