[NIFI-4919] Document the nifi-toolkit-cli

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation & Website, Tools and Build
• Assignee: Unassigned
• Reporter: Pierre Villard
• Created: 28/Feb/18 16:35
• Updated: 28/Feb/18 16:35

Description

During the PR review (https://github.com/apache/nifi/pull/2477), few comments have been made to provide the best possible documentation around the features provided by the new NiFi toolkit CLI.

Using annotations to automatically generate the documentation may be the best approach to provide an exhaustive documentation around the available commands. In addition to that a dedicated section for the toolkit binaries would probably be a good idea in the NiFi documentation.