Element vs program vs...: confusion in the docs

Description

We have some confusion in the documentation (and in the code) in that we have a number of terms that are somewhat the same, but not quite, and we are inconsistent in our use of them.

They are:

  • Element

  • Program

  • Component

  • Runnable

At certain times, they have all been used to refer to the same thing: a Flow!
But we need to clarify:

  • exactly what they mean;

  • which ones we want to use;

  • when to use them;

  • clean up their use in both the docs and in the code (as these get used in CLI doc strings); and

  • add them all to the Glossary.

Release Notes

None

Activity

Show:

John Jackson June 11, 2015 at 3:20 AM

Fixed in 3.1.0 by searching for all uses of "element" and replacing (if appropriate) with "component". In some cases, it is used in reference to a member of an array, and so was left as-is.

NitinM February 21, 2015 at 9:33 PM

This work can be done out-of-band. So, not tying it to a version.

Fixed
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Affects versions

Components

Fix versions

Priority

Created December 2, 2014 at 7:51 PM
Updated June 11, 2015 at 3:20 AM
Resolved June 11, 2015 at 3:20 AM