Skip to content

Commit

Permalink
move glossary into table
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewwormald committed Aug 13, 2024
1 parent bb94ea8 commit d451d68
Showing 1 changed file with 15 additions and 36 deletions.
51 changes: 15 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,42 +331,21 @@ b.AddStep(
---
## Example

Head on over to [./_example](./_example) to get familiar with the syntax 😊
Head on over to [./examples](./examples) to get familiar with the syntax 😊

## Glossary

**Builder:**
A struct type that facilitates the construction of workflows. It provides methods for adding steps, callbacks, timeouts, and connecting workflows.

**Callback:**
A method in the workflow API that can be used to trigger a callback function for a specified status. It passes data from a reader to the specified callback function.

**Consumer:**
A component that consumes events from an event stream. In this context, it refers to the background consumer goroutines launched by the workflow.

**EventStreamer:**
An interface representing a stream for workflow events. It includes methods for producing and consuming events.

**Graph:**
A representation of the workflow's structure, showing the relationships between different statuses and transitions.

**Producer:**
A component that produces events to an event stream. It is responsible for sending events to the stream.

**RecordStore:**
An interface representing a store for workflow records. It includes methods for storing and retrieving records.

**RoleScheduler:**
An interface representing a scheduler for roles in the workflow. It is responsible for coordinating the execution of different roles.

**Topic:**
A method that generates a topic for producing events in the event streamer based on the workflow name and status.

**Trigger:**
A method in the workflow API that initiates a workflow for a specified foreignID and starting status. It returns a runID and allows for additional configuration options.

**WireFormat:**
A format used for serializing and deserializing data for communication between workflow components. It refers to the wire format of the WireRecord.

**WireRecord:**
A struct representing a record with additional metadata used for communication between workflow components. It can be marshaled to a wire format for storage and transmission.
| **Term** | **Description** |
|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Builder** | A struct type that facilitates the construction of workflows. It provides methods for adding steps, callbacks, timeouts, and connecting workflows. |
| **Callback** | A method in the workflow API that can be used to trigger a callback function for a specified status. It passes data from a reader to the specified callback function. |
| **Consumer** | A component that consumes events from an event stream. In this context, it refers to the background consumer goroutines launched by the workflow. |
| **EventStreamer**| An interface representing a stream for workflow events. It includes methods for producing and consuming events. |
| **Graph** | A representation of the workflow's structure, showing the relationships between different statuses and transitions. |
| **Producer** | A component that produces events to an event stream. It is responsible for sending events to the stream. |
| **RecordStore** | An interface representing a store for workflow records. It includes methods for storing and retrieving records. |
| **RoleScheduler**| An interface representing a scheduler for roles in the workflow. It is responsible for coordinating the execution of different roles. |
| **Topic** | A method that generates a topic for producing events in the event streamer based on the workflow name and status. |
| **Trigger** | A method in the workflow API that initiates a workflow for a specified foreignID and starting status. It returns a runID and allows for additional configuration options. |
| **WireFormat** | A format used for serializing and deserializing data for communication between workflow components. It refers to the wire format of the WireRecord. |
| **WireRecord** | A struct representing a record with additional metadata used for communication between workflow components. It can be marshaled to a wire format for storage and transmission. |

0 comments on commit d451d68

Please sign in to comment.