Author: joewitt
Date: Tue Dec 16 19:04:26 2014
New Revision: 1646045
URL: http://svn.apache.org/r1646045
Log:
Updating guidance to latest develop branch info
Modified:
incubator/nifi/site/trunk/content/development/quickstart.md
Modified: incubator/nifi/site/trunk/content/development/quickstart.md
URL:
http://svn.apache.org/viewvc/incubator/nifi/site/trunk/content/development/quickstart.md?rev=1646045&r1=1646044&r2=1646045&view=diff
==============================================================================
--- incubator/nifi/site/trunk/content/development/quickstart.md (original)
+++ incubator/nifi/site/trunk/content/development/quickstart.md Tue Dec 16
19:04:26 2014
@@ -14,6 +14,8 @@ The code as it was initially contributed
To view the lastest codebase as we work toward an initial release checkout the
'develop' branch.
+All guidance that follows assumes you are working on the 'develop' branch.
+
## Issue Tracking
Track issues on the "NIFI" Project on the Apache Jira ([browse][jira]).
@@ -26,17 +28,24 @@ To check out the code:
git clone http://git-wip-us.apache.org/repos/asf/incubator-nifi.git
+Then checkout the 'develop' branch
+
+ git checkout develop
+
### Build steps
We're planning on revising these steps, our build process, and tests for much
more deterministic builds. For now, the steps are not automated.
1. You need a recent Java 7 JDK.
2. You need Apache [Maven 3.X][maven]. We've successfully used 3.2.3 and as
far back as 3.0.5
-3. In the root dir of the source tree run `./misc/build-order.sh` (expect
20-30 mins build time) **OR** you can build each component
-manually.
+3. Build the nar maven plugin. In the root dir of the source tree cd to
'nar-maven-plugin'.
+ Run 'mvn clean install'
+4. Build the entire code base. In the root dir of the source tree run 'mvn -T
C1.0 clean install'
+ You can tweak the maven build settings as you like but the previous command
will execute with 1 thread per core.
+5. Build the assembly/nifi application itself. In the root dir of the source
tree cd to 'assembly'.
+ Run 'mvn assembly:assembly'
-Once that is done you can go to the assemblies/nifi directory and run
-`mvn assembly:assembly`
+Now you should have a fully functioning build off the latest code in the
develop branch.
## Running the application
@@ -49,7 +58,7 @@ to 8080 is a good start, but on systems
#### Decompress and launch
-`mvn assembly:assembly` will create a tar.gz file in the target directory in
`assemblies/nifi`. This tar.gz should
+`mvn assembly:assembly` will create a tar.gz file in the target directory in
`assembly`. This tar.gz should
contain the full application. Decompressing the tar.gz should make a directory
for you containing several other
directories. `conf` contains application configuration, `logs` will contain
log files, `bin` contains a fairly
bare-bones script for launching the application, `nifi.sh`. On linux (and
possibly OS X) running `bin/nifi.sh start`
@@ -72,3 +81,4 @@ is ready for use:
[gitbrowse]:
https://git-wip-us.apache.org/repos/asf?p=incubator-nifi.git;a=summary
[gitrepo]: http://git-wip-us.apache.org/repos/asf/incubator-nifi.git
[githubrepo]: https://github.com/apache/incubator-nifi
+
