Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-280

Machine generate Processor/ReportingTask/Html documentation

    XMLWordPrintableJSON

    Details

      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

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                danbress Dan Bress
                Reporter:
                danbress Dan Bress
              • Votes:
                1 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 96h
                  96h
                  Remaining:
                  Remaining Estimate - 96h
                  96h
                  Logged:
                  Time Spent - Not Specified
                  Not Specified