From 2197049a6debe55697cbe5fe8cdd6a9d05d62f5f Mon Sep 17 00:00:00 2001 From: Aldrin Piri Date: Fri, 6 Feb 2015 15:05:14 -0500 Subject: [PATCH] Adding information on the usage of AsciiDoc for documentation and providing a link to the AsciiDoc guide for tooling --- nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc b/nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc index 16773123c9..537cd88dbe 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