[
https://issues.apache.org/jira/browse/NIFI-1795?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16779593#comment-16779593
]
Ryan Withers commented on NIFI-1795:
------------------------------------
I went the patch route because I have not forked the nifi repo yet. For the
next story that was recommended to me I will fork the repository and go the PR
route. I have my eye on another story after these two as well.
> Improve documentation regarding PropertyDescriptor name & displayName
> ---------------------------------------------------------------------
>
> Key: NIFI-1795
> URL: https://issues.apache.org/jira/browse/NIFI-1795
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Affects Versions: 0.6.1
> Reporter: Andy LoPresto
> Assignee: Ryan Withers
> Priority: Minor
> Attachments: nifi-1795.patch.zip
>
>
> As evidenced in numerous pull requests, developers are often unaware of the
> behavior of {{PropertyDescriptor}} {{name}} and {{displayName}} attributes.
> Originally, {{name}} existed and served as both the UI display value for the
> processor properties configuration dialog and as the unique identifier when
> writing/reading the properties from file storage. However, a change to the
> {{name}} value after the flow had been persisted could cause issues
> retrieving the value from file storage. Thus, {{displayName}} was introduced
> as the UI display value to allow for backward-compatible updates. The
> documentation does not sufficiently explain this information and can better
> encourage developers to provide both {{name}} and {{displayName}} attributes
> in order to be proactive on flow compatibility and to improve the foundation
> for internationalization and localization of the UI.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
