David Handermann created NIFI-14040:
---------------------------------------
Summary: Add Additional Details to Website Component Documentation
Key: NIFI-14040
URL: https://issues.apache.org/jira/browse/NIFI-14040
Project: Apache NiFi
Issue Type: Improvement
Components: Documentation & Website
Reporter: David Handermann
Assignee: David Handermann
The release of NiFi 2.0.0 included a redesigned approach to building and
publishing component documentation to the nifi-site project, based on the JSON
Runtime Manifest published in {{nifi-runtime-manifest.jar}}. The initial
implementation uses Hugo to split the JSON into separate files for each
component, and then applies separate Hugo templates for HTML generation.
The component documentation process should be updated to publish additional
details for components that have separate Markdown files. The
{{nifi-runtime-manifest.jar}} includes these Markdown files and the component
JSON definition indicates the presence of additional documentation. Publishing
the additional details documentation involves updating the prebuild script to
stage the Markdown files, and updating the component documentation templates to
include additional details references when present for the particular component
class.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
