You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2015/02/09 15:48:35 UTC
[02/18] incubator-nifi git commit: Adding information on the usage of
AsciiDoc for documentation and providing a link to the AsciiDoc guide for
tooling
Adding information on the usage of AsciiDoc for documentation and providing a link to the AsciiDoc guide for tooling
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/2197049a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/2197049a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/2197049a
Branch: refs/heads/NIFI-250
Commit: 2197049a6debe55697cbe5fe8cdd6a9d05d62f5f
Parents: c14aef4
Author: Aldrin Piri <al...@gmail.com>
Authored: Fri Feb 6 15:05:14 2015 -0500
Committer: Aldrin Piri <al...@gmail.com>
Committed: Fri Feb 6 15:05:14 2015 -0500
----------------------------------------------------------------------
nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc | 4 ++++
1 file changed, 4 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/2197049a/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc
----------------------------------------------------------------------
diff --git a/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc b/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc
index 1677312..537cd88 100644
--- a/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc
+++ b/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc
@@ -2098,6 +2098,8 @@ The back end of Apache NiFi is written in Java. The web tier makes use of JAX-RS
used to provide a user interface. We depend on several third-party JavaScript libraries, including D3 and JQuery,
among others. We make use of Apache Maven for our builds and Git for our version control system.
+Documentation is created in link:http://asciidoctor.org[AsciiDoc].
+
=== Where to Start?
@@ -2106,6 +2108,8 @@ or you can dig into any of the tickets for creating Processors. Processors shoul
outside components (except for Controller Services), so they make for excellent starting points for new NiFi developers to
get started. This exposes the developer to the NiFi API and is the most extensible part of the dataflow system.
+Tools available to facilitate documentation generation are available at link:http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc with Live Preview].
+
=== Supplying a contribution