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
115 changes: 115 additions & 0 deletions docs/Core-Development-Guide.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
[[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

* xref:What-is-Windup[What is Windup]?
* xref:Features-of-Windup-2.0[Features of Windup 2.0]
* xref:About-the-WINDUP_HOME-Variable[About the WINDUP_HOME Variable]

==== Get Started

Before you begin to contribute to Windup, take a quick tour to see how to use it.

* xref:Install-and-Configure-Maven[Install and Configure Maven]
* xref:Dev-Get-the-Windup-Source-Code[Get the Windup Source Code]
* xref:Dev-Build-Windup-from-Source[Build Windup from Source]
* xref:Dev-Execute-Windup-Built-from-Source[Execute Windup Built from Source]
* xref:Review-the-Report[Review the Report]

==== Developer Contributing Information

* xref:Dev-Development-Guidelines-and-Conventions[Developer Guidelines and Conventions]
* xref:Dev-Submit-Code-Updates-to-the-Windup-Project[Submit Code Updates to the Windup Project]

==== Understand the Windup Architecture and Structure

* xref:Windup-Processing-Overview[Windup Processing Overview]
* xref:Windup-Architectural-Components[Windup Architectural Components]
* xref:Dev-Windup-Project-Structure[Windup Project Structure]

==== Rules and Rulesets

* xref:Windup-Processing-Overview.adoc[Windup Processing Overview]
* xref:Rules-Rule-Execution-Lifecycle[Rules Execution Lifecyle]
* xref:Rules-Rule-Story-Points[Rule Story Points]
* xref:Rules-Difference-Between-XML-based-and-Java-based-Rules[Difference Between XML-based and Java-based Rules]

==== Create and Test Java Rule Add-ons

* xref:Rules-Java-based-Rule-Structure[Java-based Rule Structure]
* xref:Rules-Basic-Rule-Execution-Flow-Patterns[Basic Rule Execution Flow Patterns]
* xref:Rules-Create-a-Basic-Java-based-Rule-Add-on[Create a Basic Java-based Rule Add-on]
* xref:Rules-Create-an-Advanced-Ruleset[Create an Advanced Ruleset]

==== Create and Test XML Rules

* xref:Rules-Create-a-Basic-XML-Rule[Create a Basic XML Rule]

* xref:Rules-Test-a-Basic-XML-Rule-in-Windup[Test an XML Rule in Windup]

==== Debugging and Troubleshooting

* xref:Dev-Debugging-and-Profiling[Debugging and Profiling]
* xref:Dev-Troubleshooting[Troubleshooting]

==== Developer topics

* xref:Dev-Windup-Bootstrap[Bootstrap]
* xref:Dev-Classloading-Notes[Classloading Notes]
* xref:Dev-Connect-to-the-Graph-via-Rexster[Connect to the Graph via Rexster]
* xref:Dev-Decompiling[Decompiling]
* xref:Dev-Dependencies[Dependencies]
* xref:Dev-Frames-Extensions[Frames Extensions]
* xref:Dev-Internal-API-Features[Internal API Features]
* xref:Dev-Logging[Logging]
* xref:Dev-Variables-Stack[Variables Stack]
* xref:Dev-Port-WindRide-Functionality-to-Windup[Port WindRide Functionality to Windup]
* xref:Dev-Git-Rebasing[Git Rebasing]
* xref:Dev-Releasing-Windup[Releasing Windup]

==== Rules topics

* xref:Rules-Available-Rules-Utilities[Available Utilities]
* xref:Dev-Concepts-and-Philosophy[Concepts and Philosophy]
* xref:Rules-Creating-Rule-Operations[Creating Rules Operations]
* xref:Rules-Rulesets[Rulesets]
** xref:Ruleset-Java-Basic-Ruleset[Java Basic Ruleset]
** xref:Ruleset-Java-Classifications-and-Inline-Hints[Ruleset Java Classifications and Inline Hints]
** xref:Ruleset-Java-EE-Apps[Java EE Apps Ruleset]
** xref:Ruleset-Java-EE-Servers[Java EE Servers Ruleset]
** xref:Ruleset-Reporting[Reporting Ruleset]
* xref:Ruleset-XML[XML Ruleset]
* xref:Rules-Windup-Models[Windup Models]
* xref:Rules-Create-Java-Queries[Create Java Queries]
* xref:Rules-Rules-Metadata[Rules Metadata]
* xref:Rules-Rules-Operations[Rules Operations]
** xref:Rules-Ops-Reporting-Classification[Rules Ops: Reporting: Classification]
** xref:Rules-Ops-Reporting-Hint[Rules Ops: Reporting: Hint]
** xref:Rules-Ops-Reporting-TypeReference[Rules Ops: Reporting: TypeReference]
** xref:Rules-Ops-Xml-XsltTrasformation[Rules Ops: XML: XSLT Transformation]
* xref:Rules-Java-based-Rule-Structure[Java-Based Rule Structure]

==== Wiki and Product Documentation

* xref:About-the-Windup-Wiki[About the Windup Wiki]
* xref:Dev-Add-Images-to-the-Windup-Wiki[Add Images to the Windup Wiki]
* xref:Dev-Create-Windup-JavaDoc[Create Windup JavaDoc]
* xref:Dev-Windup-Documentation-Process[Windup Documentation Process]

==== Additional Resources

* xref:Review-the-Windup-Quickstarts[Review the Windup Quickstarts]
* xref:Get-Involved[Get Involved] - We need your feedback!
* xref:Known-Issues[Known Issues]
* xref:Report-Issues-with-Windup[Report Issues with Windup]

==== Appendix

* xref:Glossary[Glossary of Terms]
* xref:Dev-Windup-Project-Information[Windup Project Information] - Github
repository, IRC, Mailing lists, ...

97 changes: 0 additions & 97 deletions docs/Core-Development-Guide.asciidoc

This file was deleted.

12 changes: 9 additions & 3 deletions docs/Dev-Add-Images-to-the-Windup-Wiki.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[Dev-Add-Images-to-the-Windup-Wiki]]
=== Add Images to the Windup Wiki

:imagesdir: images

* Fork https://github.com/windup/windup/wiki
* Clone the Windup Wiki into a `windup.wiki/` directory using the SSH clone URL:

Expand Down Expand Up @@ -32,15 +34,19 @@

git push origin HEAD:master

* Test the new image in a page on your own Wiki.
* Test the new image in a page on your own Wiki. Don't forget to add the `:imagesdir: images` directive to the beginning of the page to point to the images directory.

image:images/IMAGE_NAME.png[New Image]
image:IMAGE_NAME.png[New Image]

+
For example:

+
image:images/windup-logo-large.png[Windup Logo]
:imagesdir: images

==== My Image

image:/windup-logo-large.png[Windup Logo]

* If it works, push the image to the upstream repository

Expand Down
57 changes: 57 additions & 0 deletions docs/Dev-Customer-Portal-Tags.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
=== Customer Portal Tags

_This is a work in progress, so please feel free to update this page with new tag suggestions!_

==== Tags Needed For Most Articles

The following is a list and description of tags that currently exist on the Customer Portal that we should use when writing Windup migration articles for the Customer Portal.

windup:: All Windup articles should use this tag so we can quickly find all the Windup articles.

migration:: All Windup articles should use this tag so a search includes the articles.

jboss-eap:: Migration material for JBoss EAP platforms.

weblogic:: Migration material related to WebLogic.

websphere:: Migration material related to WebLogic.

java:: Java related issues

==== Additional Tags That are Available

api::
archive::
authentication::
classloading::
configuration::
database::
deployment::
ejb::
jboss_cache::
jboss_clustering::
jboss_security::
jboss_remoting::
jboss_transactions::
jbossweb::
jca::
jms::
jndi::
jpa::
jsf::
ldap::
load_balancing::
mbean::
messaging::
webservices::
ws-security:: Web Service security


==== Questions

. What other tags do we need?
. Do we need version specific tags? For example, 'jboss-eap-5', 'jboss-eap-6', 'websphere-8', 'weblogic-10'.
.. If so, do we go into point releases like 'jboss-eap-6.2', 'websphere-8.5' or 'weblogic-12cR2'?
.. Would it be better just to add a bunch of release numbers like '6', '6.1', '6.2', '8', etc. and use them with a product tag to create more flexibility?


Loading