-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[WFLY-15746] WildFly Application Development Guide
- Loading branch information
Showing
1 changed file
with
86 additions
and
0 deletions.
There are no files selected for viewing
86 changes: 86 additions & 0 deletions
86
quickstarts/WFLY-15746_WildFly_Application_Development_Guide.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
= WildFly Application Development Guide | ||
:author: Eduardo Martins | ||
:email: [email protected] | ||
:toc: left | ||
:icons: font | ||
:idprefix: | ||
:idseparator: - | ||
|
||
== Overview | ||
|
||
This document specifies the development of the Development Guide feature enhancement. | ||
|
||
== Issue Metadata | ||
|
||
=== Issue | ||
|
||
* https://issues.redhat.com/browse/WFLY-15746[WFLY-15746] | ||
|
||
=== Related Issues | ||
|
||
* https://issues.redhat.com/browse/EAP7-1845[EAP7-1845] | ||
|
||
=== Dev Contacts | ||
|
||
* mailto:{email}[{author}] | ||
|
||
=== QE Contacts | ||
|
||
* mailto: | ||
|
||
=== Affected Projects or Components | ||
|
||
WildFly (WFLY Documentation and Quickstarts Components) | ||
|
||
=== Other Interested Projects | ||
|
||
== Requirements | ||
|
||
=== Hard Requirements | ||
|
||
* The guide should have a chapter for first time app developers, which should include the following new content: | ||
** How to develop a first basic application (helloworld quickstart) from scratch using Maven, a complete user story walkthrough, which should include: | ||
*** How to create the application Maven Project using standard Maven Archetypes | ||
*** How add Red Hat specifics to the application Maven Project | ||
**** Maven repositories | ||
**** Maven Plugins | ||
**** BOMs and dependencies | ||
*** How to package, deploy, run and test the application (server distribution zip) | ||
*** How to build, deploy, run and test on Openshift (basic usage) | ||
|
||
=== Nice-to-Have Requirements | ||
|
||
* The guide should have a chapter for advanced app developers, and the following content from the existent Developer Guide may be adapted and included in the Advanced app developers section: | ||
** Maven and BOMs | ||
** Modules and Classloading | ||
** Logging | ||
** Specific component/technology content (e.g. CDI) | ||
|
||
* The specific content/technology content from the existent Quickstart Guides should be adapted and included in the Advanced app developers section, with respect to the Specific component/technology content. | ||
|
||
* The chapter for first time app developers should also include the following new content: | ||
** How to develop a first basic application for each specific supported component/technology (e.g. CDI) | ||
*** Introduction to the component/Technology | ||
*** Extends the basic application development content (e.g. add needed Maven dependencies related with component/technology) | ||
*** Any other basic level content which may be useful with respect to the technology | ||
|
||
* The chapter for first time app developers may include the following new content: | ||
** How to package, deploy and run the application (bootable-jar) | ||
** How to add logging to the application (basic usage) | ||
** How to use CodeReady Workspaces / JBoss Tools (basic usage: add app project, run & debug) | ||
|
||
=== Non-Requirements | ||
|
||
* NONE | ||
|
||
== Implementation Plan | ||
|
||
* The new and adapted content will be provided in asciidoc format by EAP developers and documentation writers. | ||
|
||
== Test Plan | ||
|
||
* TODO | ||
|
||
== Community Documentation | ||
|
||
The new guide should be initially only developed for EAP 8.0 GA, and post GA adapted and contributed to upstream project. |