diff --git a/README.md b/README.md index 6147d264ae..3451b0aa15 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -JBoss AS Getting Started Guide for Developers -============================================= +JBoss AS Documentation +====================== -This project contains sources for the JBoss AS Getting Started Guide for Developers. +This project contains sources for the JBoss AS Documentation, consisting of various guides, +written in docbook, and quickstarts, examples which are discussed in the guides. -* `guide/` -- sources for the guide -* `quickstarts/` -- sources for the examples discussed in the guide +* `guides/` -- sources for the various guides +* `quickstarts/` -- sources for the examples discussed in the guides +* `dist/` -- maven script to build a zip of the built guides + quickstarts + +If you add a quickstart or a guide, don't forget to update `dist/src/main/assembly/README.md`. diff --git a/dist/README.md b/dist/README.md new file mode 100644 index 0000000000..28e2e4ffbf --- /dev/null +++ b/dist/README.md @@ -0,0 +1,14 @@ +Distribution +============ + +This is a Maven assembly to create a zip distro of the docs. To run, make sure all the docs are build + + mvn -f ../guides/pom.xml clean install + +And then run the + + mvn clean install + +You will find a zip in `target/jboss-as-docs-.zip` + +The `README.md` in `src/main/assembly` will be included in the finished zip. diff --git a/dist/pom.xml b/dist/pom.xml index 8cf1c6fccb..977d9ad117 100644 --- a/dist/pom.xml +++ b/dist/pom.xml @@ -7,10 +7,10 @@ 6-beta-2 org.jboss.as.docs - jboss-as-developer-guide-dist + jboss-as-docs-dist 7.0.0-SNAPSHOT pom - JBoss AS Developer Guide Distribution + JBoss AS Docs Distribution @@ -27,7 +27,7 @@ src/main/assembly/assembly.xml - jboss-as-developer-guide-${project.version} + jboss-as-docs-${project.version} diff --git a/dist/src/main/assembly/README.md b/dist/src/main/assembly/README.md new file mode 100644 index 0000000000..95604050b4 --- /dev/null +++ b/dist/src/main/assembly/README.md @@ -0,0 +1,19 @@ +JBoss AS Documentation +====================== + +This is the documentation JBoss AS 7. You will find a detailed tutorials in `guides`, +including: + +* Getting started developing and deploying applications using JBoss AS 7 in + `developer-getting-started-guide/en-US/html/index.htmlz. + +JBoss AS also comes with several quickstart applications, which are discussed in more +detail in the various guides. You can find them in `quickstarts`. + +Developer getting started guide: + +* `helloworld` - CDI + Servlet +* `numberguess` - CDI + JSF +* `login` - CDI + JSF + JPA + EJB + JTA +* `kitchensink` - CDI + JSF + JPA + EJB + JPA + JAX-RS + BV + diff --git a/dist/src/main/assembly/assembly.xml b/dist/src/main/assembly/assembly.xml index a7aff694bb..8b3d315e21 100644 --- a/dist/src/main/assembly/assembly.xml +++ b/dist/src/main/assembly/assembly.xml @@ -2,20 +2,19 @@ + http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.1.1.xsd"> dist - jboss-as-developer-guide-${project.version} + jboss-as-docs-${project.version} zip - ${project.basedir} + ${project.basedir}/src/main/assembly / - readme.txt + README.md @@ -29,15 +28,24 @@ **/.project **/.settings/** **/.classpath + **/README-development.md - ${project.basedir}/../guide/target/docbook/publish + ${project.basedir}/../guides/developer-getting-started-guide/target/docbook/publish /developer-getting-started-guide en-US/html/** + + ${project.basedir}/../guides/developer-getting-started-guide/ + /developer-getting-started-guide + + README.md + + + diff --git a/guides/README.md b/guides/README.md new file mode 100644 index 0000000000..b5e97452f5 --- /dev/null +++ b/guides/README.md @@ -0,0 +1,6 @@ +JBoss AS Guides +=============== + +This directory contains sources for the JBoss AS Guide.s + +* `developer-getting-started-guide/` -- The Getting Started Guide for developers, focused on how an application is built using Java EE diff --git a/dist/readme.txt b/guides/developer-getting-started-guide/README.md similarity index 100% rename from dist/readme.txt rename to guides/developer-getting-started-guide/README.md diff --git a/guide/pom.xml b/guides/developer-getting-started-guide/pom.xml similarity index 97% rename from guide/pom.xml rename to guides/developer-getting-started-guide/pom.xml index bf563f0794..c1a696e9ac 100644 --- a/guide/pom.xml +++ b/guides/developer-getting-started-guide/pom.xml @@ -35,7 +35,7 @@ JBoss_AS_-_Developer_Guide.xml en-US - src/main/docbook/en-US + ${project.basedir}/src/main/docbook/en-US images/*.jpg diff --git a/guides/developer-getting-started-guide/src/main/docbook/en-US/.cvsignore b/guides/developer-getting-started-guide/src/main/docbook/en-US/.cvsignore new file mode 100644 index 0000000000..8d7328efa4 --- /dev/null +++ b/guides/developer-getting-started-guide/src/main/docbook/en-US/.cvsignore @@ -0,0 +1 @@ +master.filtered.xml diff --git a/guide/src/main/docbook/en-US/Author_Group.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/Author_Group.xml similarity index 100% rename from guide/src/main/docbook/en-US/Author_Group.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/Author_Group.xml diff --git a/guide/src/main/docbook/en-US/Book_Info.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/Book_Info.xml similarity index 100% rename from guide/src/main/docbook/en-US/Book_Info.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/Book_Info.xml diff --git a/guide/src/main/docbook/en-US/JBoss_AS_-_Developer_Guide.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/JBoss_AS_-_Developer_Guide.xml similarity index 100% rename from guide/src/main/docbook/en-US/JBoss_AS_-_Developer_Guide.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/JBoss_AS_-_Developer_Guide.xml diff --git a/guide/src/main/docbook/en-US/gettingstarted.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/gettingstarted.xml similarity index 100% rename from guide/src/main/docbook/en-US/gettingstarted.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/gettingstarted.xml diff --git a/guide/src/main/docbook/en-US/helloworld.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/helloworld.xml similarity index 100% rename from guide/src/main/docbook/en-US/helloworld.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/helloworld.xml diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_2.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_4.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_5.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Archetype_6.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Deploy_2.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Helloworld_Deploy_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_2.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Annotation_Processor_4.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_KitchenSink_Deploy_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Login_Deploy_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_2.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_4.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_5.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_New_Server_6.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Numberguess_Deploy_3.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Start_2.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_1.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_2.png diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Eclipse_Server_Tab_3.png diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_1.jpg diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_1.png diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_2.jpg diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_2.png diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_3.jpg diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_3.png diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_4.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_4.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_4.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_4.jpg diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_4.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_4.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_4.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_4.png diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_5.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_5.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_5.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_5.jpg diff --git a/guide/src/main/docbook/en-US/images/Import_QuickStarts_5.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_5.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Import_QuickStarts_5.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Import_QuickStarts_5.png diff --git a/guide/src/main/docbook/en-US/images/Step1.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step1.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Step1.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step1.jpg diff --git a/guide/src/main/docbook/en-US/images/Step1.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step1.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Step1.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step1.png diff --git a/guide/src/main/docbook/en-US/images/Step2.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step2.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Step2.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step2.jpg diff --git a/guide/src/main/docbook/en-US/images/Step2.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step2.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Step2.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step2.png diff --git a/guide/src/main/docbook/en-US/images/Step3.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step3.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Step3.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step3.jpg diff --git a/guide/src/main/docbook/en-US/images/Step3.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step3.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Step3.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step3.png diff --git a/guide/src/main/docbook/en-US/images/Step4.jpg b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step4.jpg similarity index 100% rename from guide/src/main/docbook/en-US/images/Step4.jpg rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step4.jpg diff --git a/guide/src/main/docbook/en-US/images/Step4.png b/guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step4.png similarity index 100% rename from guide/src/main/docbook/en-US/images/Step4.png rename to guides/developer-getting-started-guide/src/main/docbook/en-US/images/Step4.png diff --git a/guide/src/main/docbook/en-US/intro.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/intro.xml similarity index 100% rename from guide/src/main/docbook/en-US/intro.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/intro.xml diff --git a/guide/src/main/docbook/en-US/kitchensink.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/kitchensink.xml similarity index 100% rename from guide/src/main/docbook/en-US/kitchensink.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/kitchensink.xml diff --git a/guide/src/main/docbook/en-US/login.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/login.xml similarity index 100% rename from guide/src/main/docbook/en-US/login.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/login.xml diff --git a/guide/src/main/docbook/en-US/numberguess.xml b/guides/developer-getting-started-guide/src/main/docbook/en-US/numberguess.xml similarity index 100% rename from guide/src/main/docbook/en-US/numberguess.xml rename to guides/developer-getting-started-guide/src/main/docbook/en-US/numberguess.xml diff --git a/guides/pom.xml b/guides/pom.xml new file mode 100644 index 0000000000..6e1e63a9bb --- /dev/null +++ b/guides/pom.xml @@ -0,0 +1,20 @@ + + + 4.0.0 + + org.jboss + jboss-parent + 6-beta-2 + + org.jboss.as.docs + jboss-as-guides-parent + 7.0.0-SNAPSHOT + pom + JBoss AS Guides Parent + + + + developer-getting-started-guide + + + diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000000..a17b88bf31 --- /dev/null +++ b/pom.xml @@ -0,0 +1,29 @@ + + + 4.0.0 + + org.jboss + jboss-parent + 6-beta-2 + + org.jboss.as.docs + jboss-as-docs-parent + 7.0.0-SNAPSHOT + pom + JBoss AS Docs Parent + + + + guides + + + + + quickstarts + + quickstarts + + + + + diff --git a/quickstarts/README-development.md b/quickstarts/README-development.md new file mode 100644 index 0000000000..107d3d9c50 --- /dev/null +++ b/quickstarts/README-development.md @@ -0,0 +1,12 @@ +JBoss AS Quickstarts +==================== + +Quickstarts (or examples, or samples) for JBoss AS. There are a number of rules for quickstarts: + +* Each quickstart should have a unique name, this enables a user to quickly identify each quickstart +* A quickstart should have a simple build that the user can quickly understand. If using maven it should: + 1. Not inherit from another POM + 2. Import the various BOMs from AS7 APIs to get version numbers + 3. Use the JBoss AS Maven Plugin to deploy the example +* The quickstart should be importable into JBoss Tools and deployable there +* The quickstart should be explained in detail in the associated user guide, including how to deploy diff --git a/quickstarts/pom.xml b/quickstarts/pom.xml new file mode 100644 index 0000000000..8b58d453dd --- /dev/null +++ b/quickstarts/pom.xml @@ -0,0 +1,23 @@ + + + 4.0.0 + + org.jboss + jboss-parent + 6-beta-2 + + org.jboss.as.docs + jboss-as-quickstarts-parent + 7.0.0-SNAPSHOT + pom + JBoss AS Quickstarts Parent + + + + helloworld + numberguess + login + kitchensink + + +