[NIFI-1053] Document the 'What if I change...' aspects of processor evolution

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation & Website
• Assignee: Unassigned
• Reporter: Alan Jackoway
• Created: 22/Oct/15 02:03
• Updated: 03/May/16 15:27

Description

Alan brought up a strong point on the dev thread. That is basically that it is unclear today or not well documented what the mindset for a developer can/should be or a user can/should be in the presence of a variety of scenarios of processor/extension changes. The questions that follow are oriented around processors. But we must do this for all extension types.

But I agree with you that we should make this a fully documented concept in the developer guide (so they know what they can/cannot do) and possibly the user guide (so they know what was done to them). We need to cover at least:

• I want to change the processor class name
• I want to change the processor package name
• I want to add processor relationships
• I want to remove processor relationships
• I want to add processor properties
• I want to remove processor properties
• I want to change a required property to optional
• I want to change an optional property to required
• I want to change the display name of a property
• I want to change the behavior of a processor that could have different side effects despite the same configuration

Issue Links

• is related to: NIFI-1052 Improve flow behavior on refactored processor names/packages