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

Include Flow Registry Clients in Docs

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 2.0.0-M2, 2.0.0-M3
    • None
    • None

    Description

      Flow Registry Clients are not yet included in the generated help docs. There is only a section in the User Guide for how to configure a registry client: https://nifi.apache.org/documentation/nifi-2.0.0-M2/html/user-guide.html#connecting-to-a-nifi-registry

      Two types exist now (one for NiFi Registry and one for GitHub), but there is room to expand to other registries.

      Flow Registry Clients can be included in a new section within the docs at the same level as Processors, Flow Analysis Rules, Reporting Tasks, etc.

      Attachments

        Activity

          Hi brianghig , Should the content be added to Versioning a DataFlow or to add a seperate section of FlowRegistryClients ?

          vanshchaudhary Vansh Chaudhary added a comment - Hi brianghig , Should the content be added to Versioning a DataFlow or to add a seperate section of FlowRegistryClients ?

          Thanks for taking a look at this, vanshchaudhary ! Personally, I'd like to see a new section of Flow Registry Clients. The Versioning a DataFlowdoc that you linked is a great guide through setting up any Flow Registry Client, but it's likely best suited as that - an overview. As folks build other FRCs, the Flow Registry Clients section could grow in a similar way to other NiFi components with docs that are generated from annotations on each implementation. What do you think?

          brianghig Brian Ghigiarelli added a comment - Thanks for taking a look at this, vanshchaudhary ! Personally, I'd like to see a new section of Flow Registry Clients. The Versioning a DataFlow doc that you linked is a great guide through setting up any Flow Registry Client, but it's likely best suited as that - an overview. As folks build other FRCs, the Flow Registry Clients section could grow in a similar way to other NiFi components with docs that are generated from annotations on each implementation. What do you think?
          mattyb149 Matt Burgess added a comment -

          I have a PR in progress but I'm not a UI expert by any means and can't figure out how to get this across the finish line. My branch is at https://github.com/mattyb149/nifi/tree/NIFI-13230 if anyone can complete this or explain what I'm missing, thanks much!

          mattyb149 Matt Burgess added a comment - I have a PR in progress but I'm not a UI expert by any means and can't figure out how to get this across the finish line. My branch is at https://github.com/mattyb149/nifi/tree/NIFI-13230 if anyone can complete this or explain what I'm missing, thanks much!
          mattyb149 Matt Burgess added a comment -

          Thank you for the screenshot mcgilman! I added that but then followed the rabbit hole into the Facade noticing we don't have methods for getting individual Flow Registry Clients by coordinate, so I've been adding those methods on the backend as I find them. Not sure if those are all necessary but they probably should be added if only for parity with other controller services.

          mattyb149 Matt Burgess added a comment - Thank you for the screenshot mcgilman ! I added that but then followed the rabbit hole into the Facade noticing we don't have methods for getting individual Flow Registry Clients by coordinate, so I've been adding those methods on the backend as I find them. Not sure if those are all necessary but they probably should be added if only for parity with other controller services.
          mcgilman Matt Gilman added a comment -

          Hey mattyb149, the piece your missing is that you need to register your new effects with the documentation module. Please see the attached screenshot. Without registering it, the effect will never be called and as a result the API call to load the registry client definition will not execute.

          mcgilman Matt Gilman added a comment - Hey mattyb149 , the piece your missing is that you need to register your new effects with the documentation module. Please see the attached screenshot. Without registering it, the effect will never be called and as a result the API call to load the registry client definition will not execute.
          mcgilman Matt Gilman added a comment -

          Sorry the screenshot posted before I sent the message. The front end changes in your branch is calling that Api to fetch the type by coordinate. If there's another way to access it, you could change the new method in the Documentation service. But it probably makes sense to fetch them in the same way.

          mcgilman Matt Gilman added a comment - Sorry the screenshot posted before I sent the message. The front end changes in your branch is calling that Api to fetch the type by coordinate. If there's another way to access it, you could change the new method in the Documentation service. But it probably makes sense to fetch them in the same way.

          People

            Unassigned Unassigned
            brianghig Brian Ghigiarelli
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated: