-
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
79 additions
and
0 deletions.
There are no files selected for viewing
79 changes: 79 additions & 0 deletions
79
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,79 @@ | ||
= 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 2 major sections, one for first time/beginners app developers, and one for advanced app developers. | ||
|
||
* The major section for first time app developers should include the following new content: | ||
** How to develop a first basic application (helloworld) from scratch using Maven, a complete user story walkthrough, which should include: | ||
*** How to create the application Maven Project, and add Red Hat Maven repositories and BOMs dependencies | ||
*** How to package, deploy and run the application (war/bootable jar, web console) | ||
*** How to add logging to the application (basic usage) | ||
*** How to test the application | ||
*** How to use CodeReady Workspaces/Studio (basic usage: add app project, run & debug) | ||
*** How to build, deploy and run on Openshift (basic usage) | ||
|
||
* The following content from the existent Developer Guide should be adapted and included in the Advanced app developers section: | ||
** Modules and Classloading | ||
** Logging | ||
** Specific component/technology content (e.g. CDI) | ||
|
||
=== Nice-to-Have Requirements | ||
|
||
* If possible, the major section 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 | ||
|
||
=== Non-Requirements | ||
|
||
* NONE | ||
|
||
== Implementation Plan | ||
|
||
* The new and adapted content will be provided in asciidoc format by WildFly developers and documentation writers. | ||
|
||
== Test Plan | ||
|
||
* TODO | ||
|
||
== Community Documentation | ||
|
||
The development guide will be develop at https://github.com/wildfly/wildfly/tree/main/docs/src/main/asciidoc/_developer-guide |