This closes #887
This commit is contained in:
commit
530852b28d
|
@ -20,3 +20,7 @@ cmake_install.cmake
|
||||||
|
|
||||||
# this file is generated
|
# this file is generated
|
||||||
artemis-native/src/main/c/org_apache_activemq_artemis_jlibaio_LibaioContext.h
|
artemis-native/src/main/c/org_apache_activemq_artemis_jlibaio_LibaioContext.h
|
||||||
|
|
||||||
|
# gitbook output
|
||||||
|
docs/user-manual/en/_book
|
||||||
|
docs/hacking-guide/en/_book
|
|
@ -1,6 +1,8 @@
|
||||||
# Building
|
# Building
|
||||||
|
|
||||||
We use Apache Maven to build the code, docs, distribution, etc. and to manage dependencies.
|
We use Apache Maven to build the code, distribution, etc. and to manage dependencies.
|
||||||
|
|
||||||
|
We use `gitbook` to build the docs.
|
||||||
|
|
||||||
The minimum required Maven version is 3.0.0.
|
The minimum required Maven version is 3.0.0.
|
||||||
|
|
||||||
|
@ -27,7 +29,7 @@ The new npm-shrinkwrap.json should be written, commit it.
|
||||||
|
|
||||||
Artemis will automate the execution and download of npm. But it may be useful to install it on your system. Simply type:
|
Artemis will automate the execution and download of npm. But it may be useful to install it on your system. Simply type:
|
||||||
|
|
||||||
$ npm install -g gitbook gitbook-cli
|
$ npm install -g gitbook-cli
|
||||||
|
|
||||||
If you don't have `npm` installed then you would need to install it first.
|
If you don't have `npm` installed then you would need to install it first.
|
||||||
|
|
||||||
|
@ -67,3 +69,7 @@ It is possible to build a distribution without the manuals and Javadocs.
|
||||||
simply run
|
simply run
|
||||||
|
|
||||||
$ mvn package
|
$ mvn package
|
||||||
|
|
||||||
|
## Building the docs
|
||||||
|
|
||||||
|
From either `docs/hacking-guide/en` or `docs/user-manual/en` run `gitbook build` (after you've installed gitbook)
|
|
@ -52,6 +52,7 @@
|
||||||
* [Spring Integration](spring-integration.md)
|
* [Spring Integration](spring-integration.md)
|
||||||
* [AeroGear Integration](aerogear-integration.md)
|
* [AeroGear Integration](aerogear-integration.md)
|
||||||
* [VertX Integration](vertx-integration.md)
|
* [VertX Integration](vertx-integration.md)
|
||||||
|
* [CDI Integration](cdi-integration.md)
|
||||||
* [Intercepting Operations](intercepting-operations.md)
|
* [Intercepting Operations](intercepting-operations.md)
|
||||||
* [Protocols and Interoperability](protocols-interoperability.md)
|
* [Protocols and Interoperability](protocols-interoperability.md)
|
||||||
* [Tools](tools.md)
|
* [Tools](tools.md)
|
||||||
|
|
Loading…
Reference in New Issue