Robert J. Mills created NIFI-667:
------------------------------------
Summary: Provide ability for an extension provider to augment the
standard NiFi built in documentation with their own "document(s)" and have the
augmented documents available in the help/NiFi Documentation "window".
Key: NIFI-667
URL: https://issues.apache.org/jira/browse/NIFI-667
Project: Apache NiFi
Issue Type: New Feature
Components: Core UI, Documentation & Website, Extensions
Reporter: Robert J. Mills
Priority: Minor
The built documentation is quite useful, in that it provides opportunities for
both
- High level/tutorial style documentation (Overview, User Guide, Exp Lang
Guide, Admin Guide, Rest Api, Developer Guide), and
- Detailed component specific documentation
The detailed component documentation can be augmented simply by adding a
component with its associated docs. However, what mechanism is available for
adding to the list of high level documents?
What follows is one possible "use case".
Organizations that create their own custom components may identify the
components as proprietary, and therefore not releasable to the public. While
each individual component can be documented in detail (using current
mechanisms), an organization may wish to provide a high level/tutorial style
overview of their entire "package"/group of proprietary extensions/components,
including a version number for the "package".
Note that the request is not for a mechanism to augment/modify the "standard"
Apache documents, as they should reflect what is provided by Apache. Rather,
the request is for the ability to add extension provider documents to the list
of documents listed in the NiFi Documentation "window"/page.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
