This closes #324
This commit is contained in:
commit
3433f5345c
File diff suppressed because it is too large
Load Diff
|
@ -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
|
||||
$ mvn package
|
||||
|
|
3
pom.xml
3
pom.xml
|
@ -1106,9 +1106,12 @@
|
|||
<exclude>**/src/test/resources/keystore</exclude>
|
||||
<exclude>**/*.log</exclude>
|
||||
<exclude>**/*.redo</exclude>
|
||||
|
||||
<!-- NPM files -->
|
||||
<exclude>**/node/**</exclude>
|
||||
<exclude>**/node_modules/**</exclude>
|
||||
<exclude>**/package.json</exclude>
|
||||
<exclude>**/npm-shrinkwrap.json</exclude>
|
||||
|
||||
<!-- things from cmake on the native build -->
|
||||
<exclude>**/CMakeCache.txt</exclude>
|
||||
|
|
Loading…
Reference in New Issue