Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-592: 

- Syncing site content with current.
- Pulling in generated docs into site content.
This commit is contained in:
Matt Gilman 2015-05-05 16:11:29 -04:00
parent 37e5548ac1
commit f3e76fef1b
18 changed files with 410 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
nifi-site/Gruntfile.js
View File

@ -2,16 +2,15 @@ module.exports = function (grunt) {
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
clean: {
options: {
force: true
},
js: ['dist/js/'],
css: ['dist/css/'],
assets: ['dist/assets/*']
assets: ['dist/assets/*'],
generated: ['dist/docs']
},
assemble: {
options: {
partials: 'src/includes/*.hbs',
@ -32,7 +31,6 @@ module.exports = function (grunt) {
}
}
},
compass: {
dist: {
options: {
@ -40,7 +38,6 @@ module.exports = function (grunt) {
}
}
},
concat: {
options: {
separator: ';'
@ -66,48 +63,82 @@ module.exports = function (grunt) {
dest: 'dist/js/app.js'
}
},
copy: {
generated: {
files: [{
expand: true,
cwd: '../nifi/nifi-docs/target/generated-docs',
src: ['*.html', 'images/*'],
dest: 'dist/docs/'
}, {
expand: true,
cwd: '../nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api',
src: ['target/nifi-web-api-*/docs/rest-api/index.html', 'target/nifi-web-api-*/docs/rest-api/images/*'],
dest: 'dist/docs/',
rename: function (dest, src) {
var path = require('path');
if (src.indexOf('images') > 0) {
return path.join(dest, 'rest-api/images', path.basename(src));
} else {
return path.join(dest, 'rest-api', path.basename(src));
}
}
}]
},
dist: {
files: [{
expand: true,
cwd: 'src/images/',
src: ['**/*.{png,jpg,gif,svg,ico}'],
dest: 'dist/images/'
}, {
expand: true,
cwd: 'bower_components/jquery/dist',
src: ['jquery.min.js'],
dest: 'dist/assets/js/'
}, {
expand: true,
cwd: 'bower_components/webfontloader',
src: ['webfontloader.js'],
dest: 'dist/assets/js/'
}, {
expand: true,
cwd: 'bower_components/font-awesome/css',
src: ['font-awesome.min.css'],
dest: 'dist/assets/stylesheets/'
}, {
expand: true,
cwd: 'bower_components/font-awesome',
src: ['fonts/*'],
dest: 'dist/assets/'
}]
expand: true,
cwd: 'src/images/',
src: ['**/*.{png,jpg,gif,svg,ico}'],
dest: 'dist/images/'
}, {
expand: true,
cwd: 'bower_components/jquery/dist',
src: ['jquery.min.js'],
dest: 'dist/assets/js/'
}, {
expand: true,
cwd: 'bower_components/webfontloader',
src: ['webfontloader.js'],
dest: 'dist/assets/js/'
}, {
expand: true,
cwd: 'bower_components/font-awesome/css',
src: ['font-awesome.min.css'],
dest: 'dist/assets/stylesheets/'
}, {
expand: true,
cwd: 'bower_components/font-awesome',
src: ['fonts/*'],
dest: 'dist/assets/'
}]
}
},
exec: {
generateDocs: {
command: 'mvn clean package',
cwd: '../nifi/nifi-docs',
stdout: true,
stderr: true
},
generateRestApiDocs: {
command: 'mvn clean package -DskipTests',
cwd: '../nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api',
stdout: true,
stderr: true
}
},
watch: {
grunt: {
files: ['Gruntfile.js'],
tasks: ['dev']
grunt: {
files: ['Gruntfile.js'],
tasks: ['dev']
},
css: {
files: 'src/scss/*.scss',
tasks: ['css']
},
script: {
script: {
files: 'src/js/*.js',
tasks: ['js']
},
@ -121,7 +152,7 @@ module.exports = function (grunt) {
}
}
});
grunt.loadNpmTasks('grunt-newer');
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-contrib-copy');
@ -129,10 +160,12 @@ module.exports = function (grunt) {
grunt.loadNpmTasks('assemble');
grunt.loadNpmTasks('grunt-contrib-compass');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-exec');
grunt.registerTask('img', ['newer:copy']);
grunt.registerTask('css', ['clean:css', 'compass']);
grunt.registerTask('js', ['clean:js', 'concat']);
grunt.registerTask('default', ['clean', 'assemble', 'css', 'js', 'img', 'copy']);
grunt.registerTask('dev', ['default', 'watch']);
grunt.registerTask('js', ['clean:js', 'concat']);
grunt.registerTask('generate-docs', ['clean:generated', 'exec:generateDocs', 'exec:generateRestApiDocs', 'copy:generated']);
grunt.registerTask('default', ['clean', 'assemble', 'css', 'js', 'img', 'generate-docs', 'copy:dist']);
grunt.registerTask('dev', ['default', 'watch']);
};

45
nifi-site/package.json
View File

@ -1,24 +1,25 @@
{
"name": "apache-nifi-site",
"version": "0.0.2-incubating",
"description": "The artifacts for the Apache NiFi site.",
"private": "true",
"repository": {
"type": "git",
"url": "http://git-wip-us.apache.org/repos/asf/incubator-nifi.git"
},
"devDependencies": {
"assemble": "^0.4.42",
"grunt": "^0.4.5",
"grunt-contrib-clean": "^0.6.0",
"grunt-contrib-compass": "^1.0.1",
"grunt-contrib-concat": "^0.5.0",
"grunt-contrib-copy": "^0.7.0",
"grunt-contrib-watch": "^0.6.1",
"grunt-newer": "^1.1.0"
},
"licenses" : [{
"type": "Apache",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}]
"name": "apache-nifi-site",
"version": "0.0.2-incubating",
"description": "The artifacts for the Apache NiFi site.",
"private": "true",
"repository": {
"type": "git",
"url": "http://git-wip-us.apache.org/repos/asf/incubator-nifi.git"
},
"devDependencies": {
"assemble": "^0.4.42",
"grunt": "^0.4.5",
"grunt-contrib-clean": "^0.6.0",
"grunt-contrib-compass": "^1.0.1",
"grunt-contrib-concat": "^0.5.0",
"grunt-contrib-copy": "^0.7.0",
"grunt-contrib-watch": "^0.6.1",
"grunt-exec": "^0.4.6",
"grunt-newer": "^1.1.0"
},
"licenses": [{
"type": "Apache",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}]
}

BIN
nifi-site/src/images/flow.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 492 KiB

After

Width:  |  Height:  |  Size: 899 KiB

2
nifi-site/src/includes/header.hbs
View File

@ -16,7 +16,7 @@
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-57264262-1', 'auto');
ga('send', 'pageview');
</script>
</script>
</head>
<body>
{{> topbar}}

5
nifi-site/src/includes/topbar.hbs
View File

@ -20,7 +20,6 @@
<ul class="dropdown">
<li><a href="index.html">Home</a></li>
<li><a href="https://blogs.apache.org/nifi/"><i class="fa fa-external-link external-link"></i>Apache NiFi Blog</a></li>
<li><a href="roadmap.html">Roadmap</a></li>
<li><a href="http://www.apache.org/licenses/LICENSE-2.0"><i class="fa fa-external-link external-link"></i>License</a></li>
</ul>
</li>
@ -32,6 +31,8 @@
<li><a href="overview.html">NiFi Overview</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="developer-guide.html">Developer Guide</a></li>
<li><a href="administrator-guide.html">Admin Guide</a></li>
<li><a href="rest-api.html">Rest Api</a></li>
</ul>
</li>
<li class="has-dropdown">
@ -52,6 +53,8 @@
<ul class="dropdown">
<li><a href="quickstart.html">Quickstart</a></li>
<li><a href="release-guide.html">Release Guide</a></li>
<li><a href="licensing-guide.html">Licensing Guide</a></li>
<li><a href="developer-guide.html">Developer Guide</a></li>
<li><a href="https://git-wip-us.apache.org/repos/asf/incubator-nifi.git"><i class="fa fa-external-link external-link"></i>Source</a></li>
<li><a href="https://issues.apache.org/jira/browse/NIFI"><i class="fa fa-external-link external-link"></i>Issues</a></li>
</ul>

7
nifi-site/src/pages/html/administrator-guide.hbs Normal file
View File

@ -0,0 +1,7 @@
---
title: Apache NiFi Administrator Guide
---
<div class="external-guide">
<iframe src="docs/administration-guide.html"></iframe>
</div>

2
nifi-site/src/pages/html/developer-guide.hbs
View File

@ -3,5 +3,5 @@ title: Apache NiFi Developer Guide
---
<div class="external-guide">
<iframe src="https://nifi.incubator.apache.org/docs/nifi-docs/developer-guide.html"></iframe>
<iframe src="docs/developer-guide.html"></iframe>
</div>

18
nifi-site/src/pages/html/download.hbs
View File

@ -23,6 +23,24 @@ title: Apache NiFi Downloads
<div class="large-12 columns">
<h2>Releases</h2>
<ul>
<li>0.0.2-incubating
<ul>
<li><a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&version=12329373">Release Notes</a></li>
<li>
Sources:
<ul>
<li><a href="https://www.apache.org/dyn/closer.cgi?path=/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-source-release.zip">nifi-0.0.2-incubating-source-release.zip</a> ( <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-source-release.zip.asc">asc</a>, <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-source-release.zip.md5">md5</a>, <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-source-release.zip.sha1">sha1</a> )</li>
</ul>
</li>
<li>
Binaries
<ul>
<li><a href="https://www.apache.org/dyn/closer.cgi?path=/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.tar.gz">nifi-0.0.2-incubating-bin.tar.gz</a> ( <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.tar.gz.asc">asc</a>, <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.tar.gz.md5">md5</a>, <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.tar.gz.sha1">sha1</a> )</li>
<li><a href="https://www.apache.org/dyn/closer.cgi?path=/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.zip">nifi-0.0.2-incubating-bin.zip</a> ( <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.zip.asc">asc</a>, <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.zip.md5">md5</a>, <a href="https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.2-incubating/nifi-0.0.2-incubating-bin.zip.sha1">sha1</a> )</li>
</ul>
</li>
</ul>
</li>
<li>0.0.1-incubating
<ul>
<li><a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&amp;version=12329078">Release Notes</a></li>

7
nifi-site/src/pages/html/mailing_lists.hbs
View File

@ -29,6 +29,13 @@ title: Apache NiFi Mailing Lists
<th>Post</th>
<th>Archive</th>
</tr>
<tr>
<td>Users Mailing List</td>
<td><a class="externalLink" href="mailto:users-subscribe@nifi.incubator.apache.org">Subscribe</a></td>
<td><a class="externalLink" href="mailto:users-unsubscribe@nifi.incubator.apache.org">Unsubscribe</a></td>
<td><a class="externalLink" href="mailto:users@nifi.incubator.apache.org">Post</a></td>
<td><a class="externalLink" href="http://mail-archives.apache.org/mod_mbox/incubator-nifi-users/">mail-archives.apache.org</a></td>
</tr>
<tr>
<td>Developers Mailing List</td>
<td><a class="externalLink" href="mailto:dev-subscribe@nifi.incubator.apache.org">Subscribe</a></td>

2
nifi-site/src/pages/html/overview.hbs
View File

@ -3,5 +3,5 @@ title: Apache NiFi Overview
---
<div class="external-guide">
<iframe src="https://nifi.incubator.apache.org/docs/nifi-docs/overview.html"></iframe>
<iframe src="docs/overview.html"></iframe>
</div>

27
nifi-site/src/pages/html/people.hbs
View File

@ -36,6 +36,11 @@ title: Apache NiFi Team
<th>Name</th>
<th>Affiliation</th>
</tr>
<tr>
<td>aldrin</td>
<td>Aldrin Piri</td>
<td></td>
</tr>
<tr>
<td>apurtell</td>
<td>Andrew Purtell</td>
@ -113,24 +118,4 @@ title: Apache NiFi Team
</tr>
</table>
</div>
</div>
<div class="medium-space"></div>
<div class="row">
<div class="large-12 columns">
<h2 class="nifi-txt">
<span>
Committers
</span>
</h2>
</div>
</div>
<div class="row">
<div class="large-12 columns">
<table>
<tr>
<th>Id</th>
<th>Name</th>
</tr>
</table>
</div>
</div>
</div>

7
nifi-site/src/pages/html/rest-api.hbs Normal file
View File

@ -0,0 +1,7 @@
---
title: Apache NiFi Developer Guide
---
<div class="external-guide">
<iframe src="docs/rest-api/index.html"></iframe>
</div>

30
nifi-site/src/pages/html/roadmap.hbs
View File

@ -1,30 +0,0 @@
---
title: Apache NiFi Roadmap
---
<div class="large-space"></div>
<div class="row">
<div class="large-12 columns">
<h1 class="nifi-txt">
<span>
Apache <span class="ni">ni</span><span class="fi">fi</span> Roadmap
</span>
</h1>
</div>
</div>
<div class="row">
<div class="large-12 columns">
<h3 class="nifi-txt">
<span>
First steps
</span>
</h3>
</div>
</div>
<div class="row">
<div class="large-12 columns">
<p class="description">
Initial work on Apache NiFi (incubating) will be focused on an initial incubating release. This means, migrating to apache infrastructure, using apache license compatible dependencies, developing developer documentation, and working out bugs introduced or discovered during this process.
</p>
</div>
</div>

45
nifi-site/src/pages/html/screencasts.hbs
View File

@ -15,7 +15,25 @@ title: Apache NiFi Screencasts
<div id="toolbar-overview" class="reveal-modal medium" data-reveal>
<h2>NiFi Toolbar Overview</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/LGXRAVUzL4U" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/LGXRAVUzL4U?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
<br/>
<a href="#" data-reveal-id="build-a-flow-1">Build a Simple Flow - Part 1</a>
<div id="build-a-flow-1" class="reveal-modal medium" data-reveal>
<h2>Build a Simple Flow - Part 1</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/jctMMHTdTQI?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
<br/>
<a href="#" data-reveal-id="build-a-flow-2">Build a Simple Flow - Part 2</a>
<div id="build-a-flow-2" class="reveal-modal medium" data-reveal>
<h2>Build a Simple Flow - Part 2</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/X6bPFgaBDIo?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
@ -24,7 +42,7 @@ title: Apache NiFi Screencasts
<div id="creating-process-groups" class="reveal-modal medium" data-reveal>
<h2>Creating Process Groups</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/hAveiDgDj-8" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/hAveiDgDj-8?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
@ -33,7 +51,25 @@ title: Apache NiFi Screencasts
<div id="creating-templates" class="reveal-modal medium" data-reveal>
<h2>Creating Templates</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/PpmL-IMoCnU" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/PpmL-IMoCnU?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
<br/>
<a href="#" data-reveal-id="summary-overview">Summary Overview</a>
<div id="summary-overview" class="reveal-modal medium" data-reveal>
<h2>Summary Overview</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/XfY9AEOYLHI?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
<br/>
<a href="#" data-reveal-id="provenance-overview">Provenance Overview</a>
<div id="provenance-overview" class="reveal-modal medium" data-reveal>
<h2>Summary Page Overview</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/WUKXed_bLws?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
@ -42,9 +78,10 @@ title: Apache NiFi Screencasts
<div id="managing-templates" class="reveal-modal medium" data-reveal>
<h2>Managing Templates</h2>
<div class="flex-video widescreen" style="display: block;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/HU5_3PlNmtQ" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/HU5_3PlNmtQ?list=PLHre9pIBAgc4e-tiq9OIXkWJX8bVXuqlG" frameborder="0" allowfullscreen></iframe>
</div>
<a class="close-reveal-modal">&#215;</a>
</div>
<br/>
</div>
</div>

2
nifi-site/src/pages/html/user-guide.hbs
View File

@ -3,5 +3,5 @@ title: Apache NiFi User Guide
---
<div class="external-guide">
<iframe src="https://nifi.incubator.apache.org/docs/nifi-docs/user-guide.html"></iframe>
<iframe src="docs/user-guide.html"></iframe>
</div>

120
nifi-site/src/pages/markdown/licensing-guide.md Normal file
View File

@ -0,0 +1,120 @@
---
title: Apache NiFi Licensing Guide
---
# Apache NiFi Release Guidelines
This document provides guidance to contributors of Apache NiFi (incubating) to help properly account for licensing, notice, and legal requirements.
#### Disclaimer:
This document is not written by lawyers. The guidance in this document is meant to compliment Apache Incubator and Apache Software Foundation guides and policies. If anything in this document is inconsistent with those then it is a defect in this document.
## Background Material
- [ASLv2](http://apache.org/licenses/LICENSE-2.0)
- [ASF License Apply](http://www.apache.org/dev/apply-license.html)
- [ASF Licensing How-To](http://www.apache.org/dev/licensing-howto.html)
- [ASF Legal Resolved](http://www.apache.org/legal/resolved.html)
- [ASF Release Policy](http://www.apache.org/dev/release.html)
- [ASF Incubator License and Notice Guidance](http://incubator.apache.org/guides/releasemanagement.html#note-license-and-notice)
## How to consistently apply licensing/legal notice information for Apache NiFi
### Apply the source header to each source file
Every source file for works submitted directly to the ASF must follow: http://apache.org/legal/src-headers.html#headers
Question: Every source file? What about test files and so on?
Answer: There are a few exceptions. Test files can be argued to have no degree of creativity. We also need our test materials at times to be exactly as they will be found in the wild. We should ensure test files have the license when possible but not to the point that it requires altering the test itself.
http://apache.org/legal/src-headers.html#faq-exceptions
Question: Do items which are generated from source during the build process require the header?
Answer: Taken directly from http://incubator.apache.org/guides/releasemanagement.html#notes-license-headers it reads:
"Copyright may not subsist in a document which is generated by an transformation from an original. In which case, the license header may be unnecessary. License headers should always be present in the original. Where it is reasonable to do so, the templates should also add the license header to the generated documents."
### Apply the proper NOTICE / LICENSE Information
For every addition or removal of a 3rd party work as a dependency or as pulled into our source directly we must ensure full
accounting of the correct LICENSE and NOTICE information.
Our source release must only account for the LICENSE/NOTICE of items that are actually in the source release itself.
Binary dependencies which are pulled in during the generation of a binary convenience package should not have their
LICENSE/NOTICE data in the source release. But, they must be accounted for in the binary package.
The LICENSE and NOTICE files found at the root of the Apache NiFi (nifi) component is considered 'The' LICENSE/NOTICE
covering the source release of 'nifi' and all subcomponents.
The LICENSE and NOTICE files found within the 'nifi-assembly' is considered 'The' LICENSE/NOTICE pair covering the binary
convenience package of 'nifi' (tar.gz, ZIP, etc..)
The Release Manager (RM) of a given release is responsible for checking all subcomponents for the presence of specific
LICENSE/NOTICE to gather all source dependency clauses as needed and place them into the overall LICENSE/NOTICE for the
source release. If generating a binary convenience package the RM will gather up a listing of all binary dependencies
as called out on subcomponents (including the assembly itself), which can contain binary dependencies, and promote
their specific NOTICE/LICENSE text to the binary package LICENSE/NOTICE associated with the assembly. The binary package
LICENSE/NOTICE then should be a combination of source license data and binary license data.
A binary artifact is any artifact which is created as the result of "compiling" or processing a source artifact.
For every subcomponent of nifi some binary artifact is produced because we make these things available as Maven artifacts. You must consider whether that artifact stands on its own as built from source or whether that artifact is comprised of materials built from source combined with other binary artifacts pulled in as dependencies.
In the case of subcomponents which produce binary artifacts which stand on their own (as would be typical in most Jar
files) then you must only account for any 3rd party works source dependencies. If you have any 3rd party works source
dependencies then you should create or edit the LICENSE and/or NOTICE local to that subcomponent AND modify the
NOTICE and/or LICENSE of the top level nifi source.
In the case of subcomponents which produce binary artifacts which themselves can bunde 3rd party works (as would be
typical in a NAR, WAR, tar.gz, zip bundle) then you must ensure that the subcomponent binary artifact itself includes
a full and complete LICENSE and/or NOTICE as needed to cover those 3rd party works. For every modification to the
subcomponent LICENSE/NOTICE for a given 3rd party work the overall Apache NiFi source and binary LICENSE/NOTICE pairs
need to be updated and/or verified as well.
To provide a subcomponent local LICENSE/NOTICE ensure there is a 'src/main/resources/META-INF/NOTICE' and
'src/main/resources/META-INF/LICENSE' as needed. During the build process Maven will place them in the customary
locations for the binary artifact. This way for every binary artifact produced from Apache NiFi there will be a
local and accurate LICENSE/NOTICE for that artifact.
### How to go about working with the LICENSE/NOTICE modifications
If the dependency is a source dependency (ie you copied in javascript, css, java source files from a website) then you
must ensure it is from [Category-A](http://www.apache.org/legal/resolved.html#category-a) licenses.
If the dependency is a binary dependency (ie maven pulled in a jar file) then you must ensure it is either from
[Category-A](http://www.apache.org/legal/resolved.html#category-a) or
[Category-B](http://www.apache.org/legal/resolved.html#category-b).
The key guides for how to apply the LICENSE/NOTICE is found in the following:
- [Source Headers](http://apache.org/legal/src-headers.html#3party)
- [Third Party Notices](http://apache.org/legal/resolved.html#required-third-party-notices.)
- [How to modify the NOTICE](http://www.apache.org/dev/licensing-howto.html#mod-notice)
Specific guidance for handling LICENSE/NOTICE application for typical MIT/BSD licenses is
described [here](http://www.apache.org/dev/licensing-howto.html#permissive-deps). For understanding what to put in the
LICENSE file look at the license of the 3rd party work. BSD licenses for instance have this statement "Redistributions
in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution." In the event you cannot find the actual
Copyright statement for a dependency then place a link to the license text they claim and indicate no copyright marks
found and provide a link to the project website.
Specific guidance for handling Apache Licensed dependencies is describe [here](http://www.apache.org/dev/licensing-howto.html#alv2-dep).
"If the dependency supplies a NOTICE file, its contents must be analyzed and the relevant portions bubbled up into the top-level NOTICE file."
Specific guidance for handling other ASF projects is found [here](http://www.apache.org/dev/licensing-howto.html#bundle-asf-product).
"It is not necessary to duplicate the line "This product includes software developed at the Apache Software
Foundation...", though the ASF copyright line and any other portions of NOTICE must be considered for propagation."
Specific guidance for handling LICENSE/NOTICE information for category-B licensed works is [here](http://apache.org/legal/resolved.html#category-b).
Place an entry in the notice indicating the work is included in binary distribution. Provide a link to the
homepage of the work. Indicate it's license. Group like licensed items together. "By attaching a prominent label to
the distribution and requiring an explicit action by the user to get the reciprocally-licensed source, users are less
likely to be unaware of restrictions significantly different from those of the Apache License. Please include the URL
to the product's homepage in the prominent label." You should not modify the LICENSE file to include the LICENSE
information of the 3rd party work in this case. That is explained nicely in http://opensource.org/faq#copyleft as
stated "Copyleft provisions apply only to actual derivatives, that is, cases where an existing copylefted work was
modified. Merely distributing a copyleft work alongside a non-copyleft work does not cause the latter to fall under
the copyleft terms."
Specific guidance for handling works in the public domain is [here](http://apache.org/legal/resolved.html#can-works-placed-in-the-public-domain-be-included-in-apache-products)

17
nifi-site/src/pages/markdown/quickstart.md
View File

@ -4,20 +4,11 @@ title: Apache NiFi Development Quickstart
# Apache NiFi Development Quickstart
This documentation is in progress, but should get many started at building Apache NiFi.
## Source Code
Apache NiFi source code is version controlled using [Git][git] version control ([browse][gitbrowse]|[checkout][gitrepo]).
The code is also mirrored to [Github][githubrepo]
The code as it was initially contributed and entered the incubator is on the 'master' branch.
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]).
@ -42,9 +33,13 @@ git checkout develop
1. You need a recent Java 7 (or newer) 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. Build the maven plugins. In the root dir of the source tree cd to `nifi-nar-maven-plugin`.
3. Ensure your MAVEN_OPTS provides sufficient memory. Some build steps are fairly memory intensive
- These settings have worked well `MAVEN_OPTS="-Xms1024m -Xmx3076m -XX:MaxPermSize=256m"`
4. Build the nifi parent. In the root dir of the source tree cd to `nifi-parent`.
Run `mvn clean install`
4. Build the entire code base. In the root dir of the source tree cd to `nifi` and run `mvn -T C2.0 clean install`
5. Build the nifi nar maven plugin. In the root dir of the source tree cd to `nifi-nar-maven-plugin`.
Run `mvn clean install`
6. Build the entire code base. In the root dir of the source tree cd to `nifi` and run `mvn -T C2.0 clean install`
You can tweak the maven build settings as you like but the previous command will execute with 2 threads per core.
Now you should have a fully functioning build off the latest code in the develop branch.

126
nifi-site/src/pages/markdown/release-guide.md
View File

@ -50,20 +50,18 @@ There are two lists here: one of specific incubator requirements, and another of
- Specifically look in the *-sources.zip artifact and ensure these items are present at the root of the archive.
- Evaluate the sources and dependencies. Does the overall LICENSE and NOTICE appear correct? Do all licenses fit within the ASF approved licenses?
- Here is an example path to a sources artifact:
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi-nar-maven-plugin/0.0.1-incubating/nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip`
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi/0.0.1-incubating/nifi-0.0.1-incubating-source-release.zip`
- Is there a README available that explains how to build the application and to execute it?
- Look in the *-sources.zip artifact root for the readme.
- Are the signatures and hashes correct for the source release?
- Validate the hashes of the sources artifact do in fact match:
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi-nar-maven-plugin/0.0.1-incubating/nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip.md5`
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi-nar-maven-plugin/0.0.1-incubating/nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip.sha1`
- Validate the signatures of the sources artifact and of each of the hashes. Here are example paths:
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi-nar-maven-plugin/0.0.1-incubating/nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip.asc`
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi-nar-maven-plugin/0.0.1-incubating/nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip.asc.md5`
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi-nar-maven-plugin/0.0.1-incubating/nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip.asc.sha1`
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi/0.0.1-incubating/nifi-0.0.1-incubating-source-release.zip.md5`
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi/0.0.1-incubating/nifi-0.0.1-incubating-source-release.zip.sha1`
- Validate the signature of the source artifact. Here is an example path:
- `https://repository.apache.org/service/local/repositories/orgapachenifi-1011/content/org/apache/nifi/nifi/0.0.1-incubating/nifi-0.0.1-incubating-source-release.zip.asc`
- Need a quick reminder on how to [verify a signature](http://www.apache.org/dev/release-signing.html#verifying-signature)?
- Do all sources have necessary headers?
- Unzip the sources file into a directory and execute `mvn install -Pcheck-licenses`
- Unzip the sources file into a directory and execute `mvn install -Pcontrib-check`
- Are there no unexpected binary files in the release?
- The only thing we'd expect would be potentially test resources files.
- Does the app (if appropriate) execute and function as expected?
@ -95,9 +93,9 @@ have in mind the release version you are planning for. For example we'll consid
Create the next version in JIRA if necessary so develop work can continue towards that release.
Create new branch off develop named after the JIRA ticket or just use the develop branch itself. Here we'll use a branch off of develop with
`git checkout -b NIFI-270`
`git checkout -b NIFI-270-RC1`
Change directory into that of the project you wish to release. For example either `cd nifi` or `cd nifi-nar-maven-plugin`
Change directory into that of the project you wish to release. For example `cd nifi`
Verify that Maven has sufficient heap space to perform the build tasks. Some plugins and parts of the build
consumes a surprisingly large amount of space. These settings have been shown to
@ -128,34 +126,34 @@ Ensure your settings.xml has been updated as shown below. There are other ways
Ensure the the full application build and tests all work by executing
`mvn -T 2.5C clean install` for a parallel build. Once that completes you can
startup and test the application by `cd assembly/target` then run `bin/nifi.sh start` in the nifi build.
startup and test the application by `cd nifi-assembly/target` then run `bin/nifi.sh start` in the nifi build.
The application should be up and running in a few seconds at `http://localhost:8080/nifi`
Evaluate and ensure the appropriate license headers are present on all source files. Ensure LICENSE and NOTICE files are complete and accurate.
Developers should always be keeping these up to date as they go along adding source and modifying dependencies to keep this burden manageable.
This command `mvn install -Pcheck-licenses` should be run as well to help validate. If that doesn't complete cleanly it must be addressed.
This command `mvn install -Pcontrib-check` should be run as well to help validate. If that doesn't complete cleanly it must be addressed.
Now its time to have maven prepare the release so execute `mvn release:prepare -Psigned_release -DscmCommentPrefix="NIFI-270 " -Darguments="-DskipTests"`.
Now its time to have maven prepare the release so execute `mvn release:prepare -Psigned_release -DscmCommentPrefix="NIFI-270-RC1 " -Darguments="-DskipTests"`.
Maven will ask:
`What is the release version for "Apache NiFi NAR Plugin"? (org.apache.nifi:nifi-nar-maven-plugin) 0.0.1-incubating: :`
`What is the release version for "Apache NiFi"? (org.apache.nifi:nifi) 0.0.1-incubating: :`
Just hit enter to accept the default.
Maven will then ask:
`What is SCM release tag or label for "Apache NiFi NAR Plugin"? (org.apache.nifi:nifi-nar-maven-plugin) nifi-nar-maven-plugin-0.0.1-incubating: : `
`What is SCM release tag or label for "Apache NiFi"? (org.apache.nifi:nifi) nifi-0.0.1-incubating: : `
Enter `nifi-nar-maven-plugin-0.0.1-incubating-RC1` or whatever the appropriate release candidate (RC) number is.
Enter `nifi-0.0.1-incubating-RC1` or whatever the appropriate release candidate (RC) number is.
Maven will then ask:
`What is the new development version for "Apache NiFi NAR Plugin"? (org.apache.nifi:nifi-nifi-nar-maven-plugin) 0.0.2-incubating-SNAPSHOT: :`
`What is the new development version for "Apache NiFi"? (org.apache.nifi:nifi) 0.0.2-incubating-SNAPSHOT: :`
Just hit enter to accept the default.
Now that preparation went perfectly it is time to perform the release and deploy artifacts to staging. To do that execute
`mvn release:perform -Psigned_release -DscmCommentPrefix="NIFI-270 " -Darguments="-DskipTests"`
`mvn release:perform -Psigned_release -DscmCommentPrefix="NIFI-270-RC1 " -Darguments="-DskipTests"`
That will complete successfully and this means the artifacts have been released to the Apache Nexus staging repository. You will see something like
@ -174,6 +172,11 @@ Validate that all the various aspects of the staged artifacts appear correct
If all looks good then push the branch to origin `git push origin NIFI-270`
If it is intended that convenience binaries will be provided for this release then the community has requested that
a copy it be made available for reviewing of the release candidate. The convenience binary, its hashes, and signature
should be placed here:
- https://dist.apache.org/repos/dist/dev/incubator/nifi
If anything isn't correct about the staged artifacts you can drop the staged repo from repository.apache.org and delete the
local tag in git. If you also delete the local branch and clear your local maven repository under org/apache/nifi then it is
as if the release never happened. Before doing that though try to figure out what went wrong. So as described here you see
@ -181,21 +184,21 @@ that you can pretty easily test the release process until you get it right. The
commands can come in handy to help do this so you can set versions to something clearly release test related.
Now it's time to initiate a vote within the PPMC. Send the vote request to `dev@nifi.incubator.apache.org`
with a subject of `[VOTE] Release Apache NiFi nifi-nar-maven-plugin-0.0.1-incubating`. The following template can be used:
with a subject of `[VOTE] Release Apache NiFi 0.0.1-incubating`. The following template can be used:
```
Hello
I am pleased to be calling this vote for the source release of Apache NiFi
nifi-nar-maven-plugin-0.0.1-incubating.
nifi-0.0.1-incubating.
The source zip, including signatures, digests, etc. can be found at:
https://repository.apache.org/content/repositories/orgapachenifi-1011
The Git tag is nifi-nar-maven-plugin-0.0.1-incubating-RC1
The Git tag is nifi-0.0.1-incubating-RC1
The Git commit ID is 72abf18c2e045e9ef404050e2bffc9cef67d2558
https://git-wip-us.apache.org/repos/asf?p=incubator-nifi.git;a=commit;h=72abf18c2e045e9ef404050e2bffc9cef67d2558
Checksums of nifi-nar-maven-plugin-0.0.1-incubating-source-release.zip:
Checksums of nifi-0.0.1-incubating-source-release.zip:
MD5: 5a580756a17b0573efa3070c70585698
SHA1: a79ff8fd0d2f81523b675e4c69a7656160ff1214
@ -211,19 +214,19 @@ https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&versio
The vote will be open for 72 hours.
Please download the release candidate and evaluate the necessary items including checking hashes, signatures, build from source, and test. The please vote:
[ ] +1 Release this package as nifi-nar-maven-plugin-0.0.1-incubating
[ ] +1 Release this package as nifi-0.0.1-incubating
[ ] +0 no opinion
[ ] -1 Do not release this package because because...
```
<br/>
A release vote is majority rule. So wait 72 hours and see if there are at least 3 binding +1 votes and no more negative votes than positive.
A release vote is majority rule. So wait 72 hours and see if there are at least 3 binding (in the PPMC sense of binding) +1 votes and no more negative votes than positive.
If so forward the vote to the IPMC. Send the vote request to `general@incubator.apache.org` with a subject of
`[VOTE] Release Apache NiFi nifi-nar-maven-plugin-0.0.1-incubating`. The following template can be used:
`[VOTE] Release Apache NiFi 0.0.1-incubating`. The following template can be used:
```
Hello
The Apache NiFi PPMC has voted to release Apache NiFi nar-maven-plugin-0.0.1-incubating.
The Apache NiFi PPMC has voted to release Apache NiFi 0.0.1-incubating.
The vote was based on the release candidate and thread described below.
We now request the IPMC to vote on this release.
@ -236,11 +239,11 @@ Here is the PPMC vote thread: [URL TO PPMC Vote Thread]
The source zip, including signatures, digests, etc. can be found at:
https://repository.apache.org/content/repositories/orgapachenifi-1011
The Git tag is nar-maven-plugin-0.0.1-incubating-RC1
The Git tag is nifi-0.0.1-incubating-RC1
The Git commit ID is 72abf18c2e045e9ef404050e2bffc9cef67d2558
https://git-wip-us.apache.org/repos/asf?p=incubator-nifi.git;a=commit;h=72abf18c2e045e9ef404050e2bffc9cef67d2558
Checksums of nar-maven-plugin-0.0.1-incubating-source-release.zip:
Checksums of nifi-0.0.1-incubating-source-release.zip:
MD5: 5a580756a17b0573efa3070c70585698
SHA1: a79ff8fd0d2f81523b675e4c69a7656160ff1214
@ -256,13 +259,13 @@ https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&versio
The vote will be open for 72 hours.
Please download the release candidate and evaluate the necessary items including checking hashes, signatures, build from source, and test. The please vote:
[ ] +1 Release this package as nar-maven-plugin-0.0.1-incubating
[ ] +1 Release this package as nifi-0.0.1-incubating
[ ] +0 no opinion
[ ] -1 Do not release this package because because...
```
<br/>
Wait 72 hours. If the vote passes then send a vote result email. Send the email to `general@incubator.apache.org, dev@nifi.incubator.apache.org`
with a subject of `[RESULT][VOTE] Release Apache NiFi nar-maven-plugin-0.0.1-incubating`. Use a template such as:
with a subject of `[RESULT][VOTE] Release Apache NiFi 0.0.1-incubating`. Use a template such as:
```
Hello
@ -277,12 +280,69 @@ Thanks to all who helped make this release possible.
Here is the IPMC vote thread: [INSERT URL OF IPMC Vote Thread]
```
<br/>
Now all the voting is done and the release is good to go. In repository.apache.org go to the staging repository
and select `release`. Then publish the source, hashes, and signatures to `https://dist.apache.org/repos/dist/release/incubator/nifi/`
Then merge the release git tag to develop and to master.
Now all the voting is done and the release is good to go.
Here are the steps of the release once the release is approved:
1. Upload source-release artifacts to dist. If the release version is 0.0.1-incubating then upload them (zip, asc, md5, sha1) to
`https://dist.apache.org/repos/dist/release/incubator/nifi/0.0.1-incubating`
2. To produce binary convenience release build the application from the raw source in staging. For each binary convenience artifact:
- Generate ascii armored detached signature by running `gpg -a -b nifi-0.0.1-incubating-bin.tar.gz`
- Generate md5 hash summary by running `md5sum nifi-0.0.1-incubating-bin.tar.gz | awk '{ printf substr($0,0,32)}' > nifi-0.0.1-incubating-bin.tar.gz.md5`
- Generate sha1 hash summary by running `sha1sum nifi-0.0.1-incubating-bin.tar.gz | awk '{ printf substr($0,0,40)}' > nifi-0.0.1-incubating-bin.tar.gz.sha1`
- Upload the bin, asc, sha1, md5 for each binary convenience build to the same location as the source release
3. In repository.apache.org go to the staging repository and select `release` and follow instructions on the site.
4. Merge the release branch into master
5. Merge the release branch into develop
6. Update the NiFi website to point to the new download(s)
7. Update the NiFi incubator status page to indicate NEWS of the release
8. In Jira mark the release version as 'Released' and 'Archived' through 'version' management in the 'administration' console.
9. Wait 24 hours then send release announcement.
- See [here][release-announce] for an understanding of why you need to wait 24 hours
- Then create an announcement like the one shown below addressed to 'announce@apache.org, general@incubator.apache.org, dev@nifi.incubator.apache.org' with a reply-to of 'general@incubator.apache.org'.
- The email has to be sent from an apache.org email address and should be by the release manager of the build.
```
SUBJECT: [ANNOUNCE] Apache NiFi 0.0.2-incubating release
BODY:
Hello
The Apache NiFi team would like to announce the release of Apache NiFi 0.0.2-incubating.
Apache NiFi is an easy to use, powerful, and reliable system to process and distribute data. Apache NiFi was made for dataflow. It supports highly configurable directed graphs of data routing, transformation, and system mediation logic.
More details on Apache NiFi can be found here:
http://nifi.incubator.apache.org/
The release artifacts can be downloaded from here:
http://nifi.incubator.apache.org/downloads/
Maven artifacts have been made available here:
https://repository.apache.org/content/repositories/releases/org/apache/nifi/
Release notes available here:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&version=12329373
Thank you
The Apache NiFi team
----
DISCLAIMER
Apache NiFi is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
```
[quickstart-guide]: http://nifi.incubator.apache.org/development/quickstart.html
[release-manager]: http://www.apache.org/dev/release-publishing.html#release_manager
[release-announce]: http://www.apache.org/dev/release.html#release-announcements
[apache-license]: http://apache.org/licenses/LICENSE-2.0
[apache-license-apply]: http://www.apache.org/dev/apply-license.html
[apache-legal-resolve]: http://www.apache.org/legal/resolved.html