From 6e83a2a75549f45639d5a30a5e202e95d67cb93d Mon Sep 17 00:00:00 2001 From: "John D. Ament" Date: Fri, 11 Nov 2016 19:49:37 -0500 Subject: [PATCH] ARTEMIS-849 Added CDI Integration to the summary file. Updated hacking guide to explain how to build docs. Added doc output to gitignore. --- .gitignore | 4 ++++ docs/hacking-guide/en/building.md | 10 ++++++++-- docs/user-manual/en/SUMMARY.md | 1 + 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 4fbf4a5f58e..a6533b645b5 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,7 @@ cmake_install.cmake # this file is generated artemis-native/src/main/c/org_apache_activemq_artemis_jlibaio_LibaioContext.h + +# gitbook output +docs/user-manual/en/_book +docs/hacking-guide/en/_book \ No newline at end of file diff --git a/docs/hacking-guide/en/building.md b/docs/hacking-guide/en/building.md index 9501343c640..36dedf7ca03 100644 --- a/docs/hacking-guide/en/building.md +++ b/docs/hacking-guide/en/building.md @@ -1,6 +1,8 @@ # 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. @@ -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: - $ 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. @@ -67,3 +69,7 @@ It is possible to build a distribution without the manuals and Javadocs. simply run $ mvn package + +## Building the docs + +From either `docs/hacking-guide/en` or `docs/user-manual/en` run `gitbook build` (after you've installed gitbook) \ No newline at end of file diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 166fee1b05f..451bd4a1f7c 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -52,6 +52,7 @@ * [Spring Integration](spring-integration.md) * [AeroGear Integration](aerogear-integration.md) * [VertX Integration](vertx-integration.md) +* [CDI Integration](cdi-integration.md) * [Intercepting Operations](intercepting-operations.md) * [Protocols and Interoperability](protocols-interoperability.md) * [Tools](tools.md)