Author: aldrin
Date: Mon Aug 8 18:35:34 2016
New Revision: 1755524
URL: http://svn.apache.org/viewvc?rev=1755524&view=rev
Log:
MINIFI-55 Updating documentation concerning the MiNiFi Toolkit
Added:
nifi/site/trunk/minifi/minifi-toolkit.html
Modified:
nifi/site/trunk/licensing-guide.html
nifi/site/trunk/minifi/download.html
nifi/site/trunk/minifi/faq.html
nifi/site/trunk/minifi/index.html
nifi/site/trunk/minifi/system-admin-guide.html
nifi/site/trunk/quickstart.html
nifi/site/trunk/release-guide.html
Modified: nifi/site/trunk/licensing-guide.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/licensing-guide.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/licensing-guide.html (original)
+++ nifi/site/trunk/licensing-guide.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
Modified: nifi/site/trunk/minifi/download.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/minifi/download.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/minifi/download.html (original)
+++ nifi/site/trunk/minifi/download.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
Modified: nifi/site/trunk/minifi/faq.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/minifi/faq.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/minifi/faq.html (original)
+++ nifi/site/trunk/minifi/faq.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
Modified: nifi/site/trunk/minifi/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/minifi/index.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/minifi/index.html (original)
+++ nifi/site/trunk/minifi/index.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
Added: nifi/site/trunk/minifi/minifi-toolkit.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/minifi/minifi-toolkit.html?rev=1755524&view=auto
==============================================================================
--- nifi/site/trunk/minifi/minifi-toolkit.html (added)
+++ nifi/site/trunk/minifi/minifi-toolkit.html Mon Aug 8 18:35:34 2016
@@ -0,0 +1,225 @@
+<!doctype html>
+<html class="no-js" lang="en">
+ <head>
+ <title>Apache NiFi MiNiFi Toolkit Guide</title>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/>
+ <link rel="shortcut icon" href="../assets/images/nifi16.ico"/>
+ <link rel="stylesheet" href="../assets/stylesheets/app.css" />
+ <link rel="stylesheet"
href="../assets/stylesheets/font-awesome.min.css">
+ <script src="../assets/js/modernizr.js"></script>
+ <script src="../assets/js/webfontloader.js"></script>
+ <script>
+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new
Date();a=s.createElement(o),
+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+ ga('create', 'UA-57264262-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+ </head>
+ <body>
+ <div class="sticky contain-to-grid">
+ <nav class="top-bar" data-topbar role="navigation">
+ <ul class="title-area">
+ <li class="name">
+ <h1>
+ <a href="index.html">
+ <img id="logo-top-bar"
src="../assets/images/nifiDrop.svg" alt="Apache NiFi"/>
+ </a>
+ </h1>
+ </li>
+ <!-- Remove the class "menu-icon" to get rid of menu icon. Take
out "Menu" to just have icon alone -->
+ <li class="toggle-topbar menu-icon"><a
href="#"><span></span></a></li>
+ </ul>
+
+ <section class="top-bar-section">
+ <!-- Right Nav Section -->
+ <ul class="right">
+ <li class="has-dropdown">
+ <a href="#">Project</a>
+ <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="http://www.apache.org/licenses/LICENSE-2.0";><i class="fa fa-external-link
external-link"></i>License</a></li>
+ </ul>
+ </li>
+ <li class="has-dropdown">
+ <a href="#">Documentation</a>
+ <ul class="dropdown">
+ <li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
+ <li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
+ </ul>
+ </li>
+ <li class="has-dropdown">
+ <a href="#">Download</a>
+ <ul class="dropdown">
+ <li><a href="download.html">Download MiNiFi</a></li>
+ <li><a
href="https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-Version0.0.1";><i
class="fa fa-external-link external-link"></i>Release Notes</a></li>
+ </ul>
+ </li>
+ <li class="has-dropdown">
+ <a href="#">Community</a>
+ <ul class="dropdown">
+ <li><a
href="https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide";>Contributor
Guide</a></li>
+ <li><a href="../mailing_lists.html">Mailing
Lists</a></li>
+ <li><a href="../people.html">People</a></li>
+ </ul>
+ </li>
+ <li class="has-dropdown">
+ <a href="#">Development</a>
+ <ul class="dropdown">
+ <li><a href="../release-guide.html">Release
Guide</a></li>
+ <li><a href="../licensing-guide.html">Licensing
Guide</a></li>
+ <li><a
href="https://git-wip-us.apache.org/repos/asf/nifi-minifi.git";><i class="fa
fa-external-link external-link"></i>Source - Java Agent</a></li>
+ <li><a href="https://github.com/apache/nifi-minifi";><i
class="fa fa-external-link external-link"></i>Source - GitHub - Java
Agent</a></li>
+ <li><a
href="https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git";><i class="fa
fa-external-link external-link"></i>Source - C++ Agent</a></li>
+ <li><a
href="https://github.com/apache/nifi-minifi-cpp";><i class="fa fa-external-link
external-link"></i>Source - GitHub - C++ Agent</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/MINIFI";><i class="fa
fa-external-link external-link"></i>Issues</a></li>
+ </ul>
+ </li>
+ <li class="has-dropdown">
+ <a href="#">ASF Links</a>
+ <ul class="dropdown">
+ <li><a href="http://www.apache.org";><i class="fa
fa-external-link external-link"></i>Apache Software Foundation</a></li>
+ <li><a
href="http://www.apache.org/foundation/sponsorship.html";><i class="fa
fa-external-link external-link"></i>Sponsorship</a></li>
+ <li><a href="http://www.apache.org/security/";><i
class="fa fa-external-link external-link"></i>Security</a></li>
+ <li><a
href="http://www.apache.org/foundation/thanks.html";><i class="fa
fa-external-link external-link"></i>Thanks</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="../index.html">Apache NiFi</a>
+ </li>
+ </ul>
+ </section>
+ </nav>
+</div>
+
+
+
+<div class="row">
+ <div class="large-12 columns">
+ <div class="large-space"></div>
+ <p><!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--></p>
+<h1 id="apache-nifi-minifi-toolkit">Apache NiFi - MiNiFi - Toolkit</h1>
+<p>MiNiFi is a child project effort of Apache NiFi. The MiNiFi toolkit aids
in creating MiNiFi configuration files from exported NiFi templates.</p>
+<h2 id="table-of-contents">Table of Contents</h2>
+<ul>
+<li><a href="#requirements">Requirements</a></li>
+<li><a href="#getting-started">Getting Started</a></li>
+<li><a href="#getting-help">Getting Help</a></li>
+<li><a href="#documentation">Documentation</a></li>
+<li><a href="#license">License</a></li>
+<li><a href="#export-control">Export Control</a></li>
+</ul>
+<h2 id="requirements">Requirements</h2>
+<ul>
+<li>JRE 1.8</li>
+</ul>
+<h2 id="getting-started">Getting Started</h2>
+<p>The latest version of the MiNiFi Toolkit Converter can be found at <a
href="http://nifi.apache.org/minifi/download.html";>http://nifi.apache.org/minifi/download.html</a>
under the <code>MiNiFi Toolkit Binaries</code> section.</p>
+<p>After downloading the binary and extracting it, to run the MiNiFi Toolkit
Converter:</p>
+<ul>
+<li><p>Change directory to the location where you installed MiNiFi Toolkit and
run it and view usage information</p>
+<ul>
+<li><p>Linux / OS X</p>
+<pre><code>$ ./config.sh</code></pre>
+</li>
+<li><p>Windows
+ execute bin/config.bat</p>
+</li>
+</ul>
+</li>
+<li><p>Usage Information</p>
+<pre><code>Usage:
+
+java org.apache.nifi.minifi.toolkit.configuration.ConfigMain <command>
options
+
+Valid commands include:
+transform: Transform template xml into MiNiFi config YAML
+validate: Validate config YAML</code></pre>
+</li>
+</ul>
+<h2 id="getting-help">Getting Help</h2>
+<p>If you have questions, you can reach out to our mailing list:
[email protected]
+(<a href="http://mail-archives.apache.org/mod_mbox/nifi-dev";>archive</a>).
+We're also often available in IRC: #nifi on
+<a href="http://webchat.freenode.net/?channels=#nifi";>irc.freenode.net</a>.</p>
+<h2 id="documentation">Documentation</h2>
+<p>See <a
href="http://nifi.apache.org/minifi";>http://nifi.apache.org/minifi</a> and <a
href="https://cwiki.apache.org/confluence/display/NIFI/MiNiFi";>https://cwiki.apache.org/confluence/display/NIFI/MiNiFi</a>
for the latest documentation.</p>
+<h2 id="license">License</h2>
+<p>Except as otherwise noted this software is licensed under the
+<a href="http://www.apache.org/licenses/LICENSE-2.0.html";>Apache License,
Version 2.0</a></p>
+<p>Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at</p>
+<p> <a
href="http://www.apache.org/licenses/LICENSE-2.0";>http://www.apache.org/licenses/LICENSE-2.0</a></p>
+<p>Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.</p>
+<h2 id="export-control">Export Control</h2>
+<p>This distribution includes cryptographic software. The country in which you
+currently reside may have restrictions on the import, possession, use, and/or
+re-export to another country, of encryption software. BEFORE using any
+encryption software, please check your country's laws, regulations and
+policies concerning the import, possession, or use, and re-export of encryption
+software, to see if this is permitted. See <a
href="http://www.wassenaar.org/";>http://www.wassenaar.org/</a> for more
+information.</p>
+<p>The U.S. Government Department of Commerce, Bureau of Industry and Security
+(BIS), has classified this software as Export Commodity Control Number (ECCN)
+5D002.C.1, which includes information security software using or performing
+cryptographic functions with asymmetric algorithms. The form and manner of this
+Apache Software Foundation distribution makes it eligible for export under the
+License Exception ENC Technology Software Unrestricted (TSU) exception (see the
+BIS Export Administration Regulations, Section 740.13) for both object code and
+source code.</p>
+<p>The following provides more details on the included cryptographic
software:</p>
+<p>Apache NiFi - MiNiFi uses BouncyCastle, Jasypt, JCraft Inc., and the
built-in
+java cryptography libraries for SSL, SSH, and the protection
+of sensitive configuration parameters. See
+<a
href="http://bouncycastle.org/about.html";>http://bouncycastle.org/about.html</a>
+<a href="http://www.jasypt.org/faq.html";>http://www.jasypt.org/faq.html</a>
+<a href="http://jcraft.com/c-info.html";>http://jcraft.com/c-info.html</a>
+<a
href="http://www.oracle.com/us/products/export/export-regulations-345813.html";>http://www.oracle.com/us/products/export/export-regulations-345813.html</a>
+for more details on each of these libraries cryptography features.</p>
+
+ </div>
+</div>
+
+ <div class="row">
+ <div class="large-12 columns footer">
+ <a href="http://www.apache.org";>
+ <img id="asf-logo" alt="Apache Software Foundation"
src="../assets/images/feather-small.gif">
+ </a>
+ <div id="copyright">
+ <p>Copyright © 2015 The Apache Software Foundation, Licensed
under the <a
+ href="http://www.apache.org/licenses/LICENSE-2.0";>Apache
License, Version 2.0</a>.<br/>Apache, the
+ Apache feather logo, NiFi, Apache NiFi and the project logo
are trademarks of The Apache Software
+ Foundation.</p>
+ </div>
+ </div>
+</div>
+
+ <script src="../assets/js/jquery.min.js"></script>
+ <script src="../assets/js/foundation.js"></script>
+ <script src="../assets/js/app.js"></script>
+ </body>
+</html>
+
Modified: nifi/site/trunk/minifi/system-admin-guide.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/minifi/system-admin-guide.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/minifi/system-admin-guide.html (original)
+++ nifi/site/trunk/minifi/system-admin-guide.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
Modified: nifi/site/trunk/quickstart.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/quickstart.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/quickstart.html (original)
+++ nifi/site/trunk/quickstart.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
Modified: nifi/site/trunk/release-guide.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/release-guide.html?rev=1755524&r1=1755523&r2=1755524&view=diff
==============================================================================
--- nifi/site/trunk/release-guide.html (original)
+++ nifi/site/trunk/release-guide.html Mon Aug 8 18:35:34 2016
@@ -48,7 +48,8 @@
<a href="#">Documentation</a>
<ul class="dropdown">
<li><a href="faq.html"><i class="fa"></i>FAQ</a></li>
- <li><a href="system-admin-guide.html"><i
class="fa"></i>MiNiFi Administrator's Guide</a></li>
+ <li><a href="system-admin-guide.html"><i
class="fa"></i>Administrator's Guide</a></li>
+ <li><a href="minifi-toolkit.html"><i
class="fa"></i>Converter Toolkit</a></li>
<li><a
href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa
fa-external-link external-link"></i>Wiki</a></li>
</ul>
</li>
