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

Refactor when documentation is generated

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: In Progress
    • Minor
    • Resolution: Unresolved
    • 0.1.0
    • None
    • Core Framework, Documentation & Website
    • None

    Description

      Currently the DocGenerator, which generates all of our Processor/ReportingTask/ControllerService documentation, is invoked directly from the NiFi class in the runtime project.

      Invoking the DocGenerator directly from the runtime hamstrings what libraries the DocGenerator can use, because the runtime project should have the least number of dependencies possible, and it currently depends on the documentation library.

      I'm proposing that we find a new way/place to invoke documentation generation such that it may bring in whatever dependencies it needs.

      The first dependency it needs is on nifi-framework-core ReflectionUtils, which would let us this copy of that class.

      Attachments

        Issue Links

          is related to

          Improvement - An improvement or enhancement to an existing feature or task. NIFI-851 Update Release Guide to describe how to deploy generated HTML documentation to website

          • Major - Major loss of function.
          • Resolved
          relates to

          Bug - A problem which impairs or prevents the functions of the product. NIFI-632 Documentation Generation: Nar ClassLoader

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          links to

          Web Link GitHub Pull Request #1744

          Activity

            People

              danbress Dan Bress
              danbress Dan Bress
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated: