You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by cl...@apache.org on 2014/12/09 17:57:31 UTC
[1/2] activemq-6 git commit: ACTIVEMQ6-9 - create html user manual
for site
Repository: activemq-6
Updated Branches:
refs/heads/master d7c7d86d5 -> d5359535e
ACTIVEMQ6-9 - create html user manual for site
https://issues.apache.org/jira/browse/ACTIVEMQ6-9
The release profile now builds a static html version of the user manual for the web site using gitbook.
Also added a new profile 'distro' that builds the distribution but without the docs.
Updated read me with build process.
Project: http://git-wip-us.apache.org/repos/asf/activemq-6/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-6/commit/395b90e0
Tree: http://git-wip-us.apache.org/repos/asf/activemq-6/tree/395b90e0
Diff: http://git-wip-us.apache.org/repos/asf/activemq-6/diff/395b90e0
Branch: refs/heads/master
Commit: 395b90e0662f131fa67956badcc862a46a8fbb1d
Parents: d7c7d86
Author: Andy Taylor <an...@apache.org>
Authored: Tue Dec 9 08:35:33 2014 +0000
Committer: Andy Taylor <an...@apache.org>
Committed: Tue Dec 9 08:35:33 2014 +0000
----------------------------------------------------------------------
README.md | 33 ++++--
activemq-website/pom.xml | 115 ++++++++++++-------
distribution/activemq/pom.xml | 58 +++-------
distribution/activemq/src/main/assembly/dep.xml | 1 +
examples/jms/jms-bridge/pom.xml | 5 -
pom.xml | 25 ++++
6 files changed, 141 insertions(+), 96 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/395b90e0/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index dbdda1c..0bffbaa 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,31 @@ unsolved [1]. This is specially true for the 'site' plugin [2].
[1]: <https://cwiki.apache.org/MAVEN/maven-3x-compatibility-notes.html>
[2]: <https://cwiki.apache.org/MAVEN/maven-3x-and-site-plugin.html>
+
+## building the distribution
+
+If you want to build the full release with documentation, Javadocs and the full web site then run the following:
+
+```% mvn -Prelease package```
+
+If you want to install it to your local maven repo then run
+
+```% mvn -Prelease install```
+
+The full release uses gitbook to build a static website from the documentation, if you don't have gitbook installed then
+ install gitbook using npm
+
+```npm install -g gitbook```
+
+If you dont have npm installed then you would need to install that first, on Fedora this would be
+
+```yum install npm```
+
+It is possible to build a distribution with out the manuals and javadocs if you dont have or want gitbook installed,
+simply run
+
+```% mvn -Prelease distro```
+
## Tests
To run the unit tests:
@@ -71,14 +96,6 @@ If you are trying to copy the examples somewhere else and modifying them. Consid
cd examples/jms/topic && mvn dependency:list
```
-## To build a release artifact
-
-```% mvn -Prelease install```
-
-## To build the release bundle
-
-```% mvn -Prelease package```
-
## Eclipse
We recommend using Eclipse Kepler (4.3), due to the built-in support
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/395b90e0/activemq-website/pom.xml
----------------------------------------------------------------------
diff --git a/activemq-website/pom.xml b/activemq-website/pom.xml
index 5340ffe..00254fd 100644
--- a/activemq-website/pom.xml
+++ b/activemq-website/pom.xml
@@ -47,50 +47,81 @@
<properties>
<activemq.basedir>${project.basedir}/..</activemq.basedir>
+ <webapp-dir>${project.artifactId}-${project.version}</webapp-dir>
+ <webapp-outdir>${basedir}/target/classes/user-manual</webapp-outdir>
</properties>
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.1</version>
- <executions>
- <execution>
- <id>javadoc-jar</id>
- <phase>package</phase>
- <goals>
- <goal>jar</goal>
- </goals>
- <configuration>
- <doclet>org.jboss.apiviz.APIviz</doclet>
- <docletArtifact>
- <groupId>org.jboss.apiviz</groupId>
- <artifactId>apiviz</artifactId>
- <version>1.3.2.GA</version>
- </docletArtifact>
- <useStandardDocletOptions>true</useStandardDocletOptions>
- <minmemory>128m</minmemory>
- <maxmemory>512m</maxmemory>
- <quiet>false</quiet>
- <!-- switch on dependency-driven aggregation -->
- <includeDependencySources>true</includeDependencySources>
+ <profiles>
+ <profile>
+ <id>release</id>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.10.1</version>
+ <executions>
+ <execution>
+ <id>javadoc-jar</id>
+ <phase>package</phase>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ <configuration>
+ <doclet>org.jboss.apiviz.APIviz</doclet>
+ <docletArtifact>
+ <groupId>org.jboss.apiviz</groupId>
+ <artifactId>apiviz</artifactId>
+ <version>1.3.2.GA</version>
+ </docletArtifact>
+ <useStandardDocletOptions>true</useStandardDocletOptions>
+ <minmemory>128m</minmemory>
+ <maxmemory>512m</maxmemory>
+ <quiet>false</quiet>
+ <!-- switch on dependency-driven aggregation -->
+ <includeDependencySources>true</includeDependencySources>
- <dependencySourceIncludes>
- <!-- include ONLY dependencies I control -->
- <dependencySourceInclude>org.apache.activemq:activemq-core-client</dependencySourceInclude>
- <dependencySourceInclude>org.apache.activemq:activemq-jms-client</dependencySourceInclude>
- <dependencySourceInclude>org.apache.activemq:activemq-server</dependencySourceInclude>
- <dependencySourceInclude>org.apache.activemq:activemq-jms-server</dependencySourceInclude>
- <dependencySourceInclude>org.apache.activemq:activemq-journal</dependencySourceInclude>
- <dependencySourceInclude>org.apache.activemq:activemq-selector</dependencySourceInclude>
- </dependencySourceIncludes>
- <quiet>false</quiet>
- <aggregate>true</aggregate>
- <excludePackageNames>org.apache.activemq.core:org.apache.activemq.utils</excludePackageNames>
- </configuration>
+ <dependencySourceIncludes>
+ <!-- include ONLY dependencies I control -->
+ <dependencySourceInclude>org.apache.activemq:activemq-core-client</dependencySourceInclude>
+ <dependencySourceInclude>org.apache.activemq:activemq-jms-client</dependencySourceInclude>
+ <dependencySourceInclude>org.apache.activemq:activemq-server</dependencySourceInclude>
+ <dependencySourceInclude>org.apache.activemq:activemq-jms-server</dependencySourceInclude>
+ <dependencySourceInclude>org.apache.activemq:activemq-journal</dependencySourceInclude>
+ <dependencySourceInclude>org.apache.activemq:activemq-selector</dependencySourceInclude>
+ </dependencySourceIncludes>
+ <quiet>false</quiet>
+ <aggregate>true</aggregate>
+ <excludePackageNames>org.apache.activemq.core:org.apache.activemq.utils</excludePackageNames>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <version>1.6</version>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <configuration>
+ <target>
+ <!-- lets generate the gitbook -->
+ <mkdir dir="${webapp-outdir}/gitbook"/>
+ <echo>executing gitbook</echo>
+ <exec executable="gitbook">
+ <arg value="build"/>
+ <arg value="${basedir}/../docs/user-manual/en"/>
+ <arg value="--output=${webapp-outdir}"/>
+ </exec>
+ </target>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
</execution>
- </executions>
- </plugin>
- </plugins>
- </build>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
</project>
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/395b90e0/distribution/activemq/pom.xml
----------------------------------------------------------------------
diff --git a/distribution/activemq/pom.xml b/distribution/activemq/pom.xml
index 7911837..9fd862e 100644
--- a/distribution/activemq/pom.xml
+++ b/distribution/activemq/pom.xml
@@ -69,11 +69,6 @@
</dependency>
<dependency>
<groupId>org.apache.activemq</groupId>
- <artifactId>activemq-jboss-as-integration</artifactId>
- <version>${project.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.activemq</groupId>
<artifactId>activemq-ra</artifactId>
<version>${project.version}</version>
</dependency>
@@ -84,11 +79,6 @@
</dependency>
<dependency>
<groupId>org.apache.activemq</groupId>
- <artifactId>activemq-twitter-integration</artifactId>
- <version>${project.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.activemq</groupId>
<artifactId>activemq-vertx-integration</artifactId>
<version>${project.version}</version>
</dependency>
@@ -161,12 +151,6 @@
<version>6.0.0-SNAPSHOT</version>
</dependency>
<dependency>
- <groupId>org.apache.activemq</groupId>
- <artifactId>activemq-website</artifactId>
- <version>6.0.0-SNAPSHOT</version>
- <classifier>javadoc</classifier>
- </dependency>
- <dependency>
<groupId>org.eclipse.jetty.aggregate</groupId>
<artifactId>jetty-all-server</artifactId>
</dependency>
@@ -179,33 +163,25 @@
<artifactId>jolokia-war</artifactId>
<type>war</type>
</dependency>
- <!-- javadoc -->
- <dependency>
- <groupId>org.apache.activemq</groupId>
- <artifactId>activemq-core-client</artifactId>
- <version>${project.version}</version>
- <classifier>javadoc</classifier>
- </dependency>
- <dependency>
- <groupId>org.apache.activemq</groupId>
- <artifactId>activemq-server</artifactId>
- <version>${project.version}</version>
- <classifier>javadoc</classifier>
- </dependency>
- <dependency>
- <groupId>org.apache.activemq</groupId>
- <artifactId>activemq-jms-server</artifactId>
- <version>${project.version}</version>
- <classifier>javadoc</classifier>
- </dependency>
- <dependency>
- <groupId>org.apache.activemq</groupId>
- <artifactId>activemq-jms-client</artifactId>
- <version>${project.version}</version>
- <classifier>javadoc</classifier>
- </dependency>
</dependencies>
+ <profiles>
+ <profile>
+ <id>release</id>
+ <dependencies>
+ <!-- javadoc -->
+ <dependency>
+ <groupId>org.apache.activemq</groupId>
+ <artifactId>activemq-website</artifactId>
+ <version>6.0.0-SNAPSHOT</version>
+ <classifier>javadoc</classifier>
+ </dependency>
+ </dependencies>
+ <build>
+ </build>
+ </profile>
+ </profiles>
+
<build>
<resources>
<resource>
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/395b90e0/distribution/activemq/src/main/assembly/dep.xml
----------------------------------------------------------------------
diff --git a/distribution/activemq/src/main/assembly/dep.xml b/distribution/activemq/src/main/assembly/dep.xml
index 270c239..0c2e323 100644
--- a/distribution/activemq/src/main/assembly/dep.xml
+++ b/distribution/activemq/src/main/assembly/dep.xml
@@ -34,6 +34,7 @@
<!-- dependencies -->
<include>org.jboss.spec.javax.jms:jboss-jms-api_2.0_spec</include>
<include>org.jboss.logmanager:jboss-logmanager</include>
+ <include>org.jboss.logging:jboss-logging</include>
<include>org.jboss:jboss-common-core</include>
<include>io.netty:netty-all</include>
<include>org.apache.qpid:proton-j</include>
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/395b90e0/examples/jms/jms-bridge/pom.xml
----------------------------------------------------------------------
diff --git a/examples/jms/jms-bridge/pom.xml b/examples/jms/jms-bridge/pom.xml
index 20231fc..689f8bf 100644
--- a/examples/jms/jms-bridge/pom.xml
+++ b/examples/jms/jms-bridge/pom.xml
@@ -24,11 +24,6 @@
<version>${project.version}</version>
</dependency>
<dependency>
- <groupId>org.apache.activemq</groupId>
- <artifactId>activemq-jboss-as-integration</artifactId>
- <version>${project.version}</version>
- </dependency>
- <dependency>
<groupId>org.jboss</groupId>
<artifactId>jboss-transaction-spi</artifactId>
</dependency>
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/395b90e0/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index f9fa4d1..29c3688 100644
--- a/pom.xml
+++ b/pom.xml
@@ -476,6 +476,31 @@
</modules>
</profile>
<profile>
+ <id>distro</id>
+ <modules>
+ <module>activemq-dto</module>
+ <module>activemq-web</module>
+ <module>activemq-website</module>
+ <module>activemq-bootstrap</module>
+ <module>activemq-commons</module>
+ <module>activemq-selector</module>
+ <module>activemq-core-client</module>
+ <module>activemq-server</module>
+ <module>activemq-jms-client</module>
+ <module>activemq-jms-server</module>
+ <module>activemq-native</module>
+ <module>activemq-journal</module>
+ <module>activemq-ra</module>
+ <module>activemq-rest</module>
+ <module>activemq-tools</module>
+ <module>activemq-service-extensions</module>
+ <module>integration/activemq-spring-integration</module>
+ <module>integration/activemq-aerogear-integration</module>
+ <module>integration/activemq-vertx-integration</module>
+ <module>distribution</module>
+ </modules>
+ </profile>
+ <profile>
<id>release</id>
<modules>
<module>activemq-dto</module>
[2/2] activemq-6 git commit: Merge #38 on HTML site generation from MD
Posted by cl...@apache.org.
Merge #38 on HTML site generation from MD
Project: http://git-wip-us.apache.org/repos/asf/activemq-6/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-6/commit/d5359535
Tree: http://git-wip-us.apache.org/repos/asf/activemq-6/tree/d5359535
Diff: http://git-wip-us.apache.org/repos/asf/activemq-6/diff/d5359535
Branch: refs/heads/master
Commit: d5359535e71936d46684c10e3951e97882431cff
Parents: d7c7d86 395b90e
Author: Clebert Suconic <cl...@apache.org>
Authored: Tue Dec 9 11:56:47 2014 -0500
Committer: Clebert Suconic <cl...@apache.org>
Committed: Tue Dec 9 11:56:47 2014 -0500
----------------------------------------------------------------------
README.md | 33 ++++--
activemq-website/pom.xml | 115 ++++++++++++-------
distribution/activemq/pom.xml | 58 +++-------
distribution/activemq/src/main/assembly/dep.xml | 1 +
examples/jms/jms-bridge/pom.xml | 5 -
pom.xml | 25 ++++
6 files changed, 141 insertions(+), 96 deletions(-)
----------------------------------------------------------------------