Apache/nifi
1
0
Fork 0
mirror of https://github.com/apache/nifi.git synced 2025-02-26 13:39:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

NIFI-152 - Fixing broken link, adding info about Documentation

Browse Source
This commit is contained in:
danbress 2015-02-01 09:10:47 -05:00
parent 497767389d
commit 3462579688
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
nifi/nifi-docs/src/main/asciidoc/developer-guide.adoc
View File

@ -70,7 +70,7 @@ high-level description of the most common extension points:
many different Processors to load the dataset themselves.
- FlowFilePrioritizer
* The FlowFilePrioritizer interface provides a mechanism by which <<flowfile>s
* The FlowFilePrioritizer interface provides a mechanism by which <<flowfile>>s
in a queue can be prioritized, or sorted, so that the FlowFiles can be processed in an order
that is most effective for a particular use case.
@ -666,14 +666,18 @@ provides a "Usage" menu item in the context menu. Additionally, the
UI exposes a "Help" link in the top-right corner, from which the same
Usage information can be found.
The advanced documentation of a Processor is provided as an HTML file.
The advanced documentation of a Processor is provided as an HTML file named `additionalDetails.html`.
This file should exist within a directory whose name is the
fully-qualified
name of the component, and this directory's parent should be named
`docs` and exist in the root of the Processor's jar.
The mechanism provided for this will be changing as of the 0.1.0
release. At that time, this section will be updated to reflect
the new procedures for providing this advanced documentation.
This file will be linked from a generated HTML file that will contain
all the Capability, Keyword, PropertyDescription and Relationship information,
so it will not be necessary to duplicate that information. This is a place
to provide a rich explanation of what this processor is doing, what kind of
data it expects and produces, and what FlowFile attributes it expects and produces.
Because this documentation is in an HTML format, you may include images and tables
to best document this component.