activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From clebertsuco...@apache.org
Subject [1/3] activemq-artemis git commit: Update hacking guide with instructions to regenerate the shrinkwrap file
Date Tue, 19 Jan 2016 14:44:09 GMT
Repository: activemq-artemis
Updated Branches:
  refs/heads/master 044e8e115 -> 3433f5345


Update hacking guide with instructions to regenerate the shrinkwrap file


Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/42583701
Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/42583701
Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/42583701

Branch: refs/heads/master
Commit: 4258370142575392ddc6e61f7ce9b912fc0f3d2d
Parents: dcdba1f
Author: Paul Gallagher <pgallagh@redhat.com>
Authored: Tue Jan 19 11:46:45 2016 +0000
Committer: Paul Gallagher <pgallagh@redhat.com>
Committed: Tue Jan 19 11:57:25 2016 +0000

----------------------------------------------------------------------
 docs/hacking-guide/en/building.md | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/42583701/docs/hacking-guide/en/building.md
----------------------------------------------------------------------
diff --git a/docs/hacking-guide/en/building.md b/docs/hacking-guide/en/building.md
index 2651745..e1cd45b 100644
--- a/docs/hacking-guide/en/building.md
+++ b/docs/hacking-guide/en/building.md
@@ -9,12 +9,19 @@ still unsolved. This is specially true for the ['site' plugin](https://maven.apa
 
 ## Full Release
 
-The full release uses `gitbook` to build a static website from the documentation, if you
don't have `gitbook` installed 
-then you can build the distribution without docs (see below) or install `gitbook` using `npm`:
+#### Upgrading the `gitbook` version and regenerating the `npm-shrinkwrap.json` file
+The full release uses `gitbook` to build a static website from the documentation. This is
automatically installed using
+an `NPM` plugin and is controled via a package.json file.
 
-    $ npm install -g gitbook gitbook-cli
+Install `NPM` using the instructions below
 
-If you don't have `npm` installed then you would need to install it first.
+    cd artemis-website
+    alter the `package.json` changing the version
+    npm cache clean; rm -rf ./node_modules/ ./node npm-shrinkwrap.json
+    npm install --save-dev
+    npm shrinkwrap --dev
+
+The new npm-shrinkwrap.json should be written, commit it.
 
 #### Install npm On Fedora
 
@@ -42,7 +49,7 @@ To install it to your local maven repo:
 
 ## Build the distribution without docs
 
-It is possible to build a distribution with out the manuals and Javadocs if you don't have
or want `gitbook` installed, 
+It is possible to build a distribution with out the manuals and Javadocs.
 simply run
 
-    $ mvn package
\ No newline at end of file
+    $ mvn package


Mime
View raw message