[NIFI-280] Machine generate Processor/ReportingTask/Html documentation

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.0.1
• Fix Version/s: 0.1.0
• Component/s: Core Framework, Core UI, Documentation & Website
• Assignee: Dan Bress
• Reporter: Dan Bress
• Created: 17/Jan/15 13:42
• Updated: 18/Mar/15 12:19
• Resolved: 18/Mar/15 03:54

Description

The goals of this effort will be:

• Machine generate as much of the basic(processor description, property description, relationship description) info as possible. This
  will make the developers lives better by storing this information in one
  place, and make users lives better by having the "inline" documentation
  match the "usage" documentation. This will also ensure that all the
  documentation is formatted consistently.
• Allow the developer to optionally provide additional html and
  images that would be linked from the machine generated documentation
• Provide a way for the documentation to be generated statically
  and linked from the Apache NiFi webpage

Issue Links

• incorporates: NIFI-309 Support additional documentation annotations