[GitHub] [nifi-registry] bbende commented on issue #163: NIFIREG-233 Setup ExtensionDocWriter with HTML implementation and RES…

[GitBox <gi...@apache.org>]

bbende commented on issue #163: NIFIREG-233 Setup ExtensionDocWriter with HTML implementation and RES…
URL: https://github.com/apache/nifi-registry/pull/163#issuecomment-478992572
 
 
   @kevdoran thanks for reviewing.. I'm not sure I totally follow the comment about storing static HTML. The two things stored statically in the DB are the extension descriptor (serialized JSON of the Extension objcect) and the additionalDetails.html (if present). The HtmlDocumentationWriter is writing out the HTML content at runtime using an Extension object as input, and creates a link from the main docs to the additionalDetails if it is present. 
   
   I think this works nicely because if we ever want to change/update anything about the docs, all we have to do is release a new version of registry and the changes start taking effect, no stored docs that we need to run through and migrate.
   
   I envision this mostly being used from the NiFi side of things when there is some type of UX where you can search for extensions and you can click a link to view the docs for an extension which could pop open a new window with this content. Maybe if we build out new features on the registry UI it could be used there as well.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services