[HOP-4479] Beam : Document plugin development guidelines

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: Migrated to GHI
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Morteza Nouri
• Created: 16/Oct/22 10:23
• Updated: 15/Feb/23 08:09
• Resolved: 15/Feb/23 08:09

Description

According to my experience, if one wants to develop a new plugin, he/she comes with lots of unknown codes that they don't have any documentation.In practice, it's very hard to figure out functionality of different parts of source code. For example:

• How transforms translated to run on Beam?(e.g, TextFile Input). we need top down approach to figure out what's happening.
• How we can develop transform to run on Beam? (e.g, what's handler and how to develop one)
• Explanation of Data, Dialog, Meta classes which are common to develop transforms.