Skip to content

Commit

Permalink
Reorganize
Browse files Browse the repository at this point in the history
  • Loading branch information
pmuir committed Jun 13, 2011
1 parent 599151e commit 5dd77e6
Show file tree
Hide file tree
Showing 100 changed files with 151 additions and 15 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`.
14 changes: 14 additions & 0 deletions dist/README.md
Original file line number Diff line number Diff line change
@@ -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-<version>.zip`

The `README.md` in `src/main/assembly` will be included in the finished zip.
6 changes: 3 additions & 3 deletions dist/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
<version>6-beta-2</version>
</parent>
<groupId>org.jboss.as.docs</groupId>
<artifactId>jboss-as-developer-guide-dist</artifactId>
<artifactId>jboss-as-docs-dist</artifactId>
<version>7.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>JBoss AS Developer Guide Distribution</name>
<name>JBoss AS Docs Distribution</name>

<build>
<plugins>
Expand All @@ -27,7 +27,7 @@
<descriptors>
<descriptor>src/main/assembly/assembly.xml</descriptor>
</descriptors>
<finalName>jboss-as-developer-guide-${project.version}</finalName>
<finalName>jboss-as-docs-${project.version}</finalName>
</configuration>
</execution>
</executions>
Expand Down
19 changes: 19 additions & 0 deletions dist/src/main/assembly/README.md
Original file line number Diff line number Diff line change
@@ -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

20 changes: 14 additions & 6 deletions dist/src/main/assembly/assembly.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@

<assembly xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.1.1.xsd
">
http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.1.1.xsd">
<id>dist</id>
<baseDirectory>jboss-as-developer-guide-${project.version}</baseDirectory>
<baseDirectory>jboss-as-docs-${project.version}</baseDirectory>
<formats>
<format>zip</format>
</formats>

<fileSets>
<fileSet>
<directory>${project.basedir}</directory>
<directory>${project.basedir}/src/main/assembly</directory>
<outputDirectory>/</outputDirectory>
<includes>
<include>readme.txt</include>
<include>README.md</include>
</includes>
</fileSet>
<fileSet>
Expand All @@ -29,15 +28,24 @@
<exclude>**/.project</exclude>
<exclude>**/.settings/**</exclude>
<exclude>**/.classpath</exclude>
<exclude>**/README-development.md</exclude>
</excludes>
</fileSet>
<fileSet>
<directory>${project.basedir}/../guide/target/docbook/publish</directory>
<directory>${project.basedir}/../guides/developer-getting-started-guide/target/docbook/publish</directory>
<outputDirectory>/developer-getting-started-guide</outputDirectory>
<includes>
<include>en-US/html/**</include>
</includes>
</fileSet>
<fileSet>
<directory>${project.basedir}/../guides/developer-getting-started-guide/</directory>
<outputDirectory>/developer-getting-started-guide</outputDirectory>
<includes>
<include>README.md</include>
</includes>

</fileSet>
</fileSets>

</assembly>
6 changes: 6 additions & 0 deletions guides/README.md
Original file line number Diff line number Diff line change
@@ -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
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<sourceDocumentName>JBoss_AS_-_Developer_Guide.xml</sourceDocumentName>
<masterTranslation>en-US</masterTranslation>
<imageResource>
<directory>src/main/docbook/en-US</directory>
<directory>${project.basedir}/src/main/docbook/en-US</directory>
<includes>
<include>images/*.jpg</include>
</includes>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
master.filtered.xml
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
20 changes: 20 additions & 0 deletions guides/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.jboss</groupId>
<artifactId>jboss-parent</artifactId>
<version>6-beta-2</version>
</parent>
<groupId>org.jboss.as.docs</groupId>
<artifactId>jboss-as-guides-parent</artifactId>
<version>7.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>JBoss AS Guides Parent</name>


<modules>
<module>developer-getting-started-guide</module>
</modules>

</project>
29 changes: 29 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.jboss</groupId>
<artifactId>jboss-parent</artifactId>
<version>6-beta-2</version>
</parent>
<groupId>org.jboss.as.docs</groupId>
<artifactId>jboss-as-docs-parent</artifactId>
<version>7.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>JBoss AS Docs Parent</name>


<modules>
<module>guides</module>
</modules>

<profiles>
<profile>
<id>quickstarts</id>
<modules>
<module>quickstarts</module>
</modules>
</profile>
</profiles>

</project>
12 changes: 12 additions & 0 deletions quickstarts/README-development.md
Original file line number Diff line number Diff line change
@@ -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
23 changes: 23 additions & 0 deletions quickstarts/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.jboss</groupId>
<artifactId>jboss-parent</artifactId>
<version>6-beta-2</version>
</parent>
<groupId>org.jboss.as.docs</groupId>
<artifactId>jboss-as-quickstarts-parent</artifactId>
<version>7.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>JBoss AS Quickstarts Parent</name>


<modules>
<module>helloworld</module>
<module>numberguess</module>
<module>login</module>
<module>kitchensink</module>
</modules>

</project>

0 comments on commit 5dd77e6

Please sign in to comment.