Skip to content

Commit b584180

Browse files
author
Lorna-Kelly
committed
Add Copilot suggestions
Signed-off-by: Lorna-Kelly <lorna.kelly@ibm.com>
1 parent cb2db90 commit b584180

1 file changed

Lines changed: 19 additions & 18 deletions

File tree

adr/v1.0-adr-shared-workflow-editor.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Proposed
66

77
## Context
88

9-
There is a need for a shared editor for the CNCF Workflow Specification that
9+
There is a need for a shared editor for the CNCF Serverless Workflow Specification that
1010
can be used consistently by multiple implementations (e.g. Quarkus Flow,
1111
SonataFlow, ZigFlow, Synapse, Lemline), as different tools provide inconsistent
12-
authoring and visualisation experiences, leading to duplicated effort and fragmented tooling.
12+
authoring and visualization experiences, leading to duplicated effort and fragmented tooling.
1313

1414
Today we have:
1515

@@ -24,16 +24,16 @@ We want to converge on a single core editor stack driven by the CNCF
2424
Serverless Workflow Specification, with a collaboration model that allows
2525
multiple vendors/maintainers to contribute and embed it.
2626

27-
This ADR formalises the decision to build a shared editor, with a strictly
27+
This ADR formalizes the decision to build a shared editor, with a strictly
2828
scoped MVP, aligned with the proposal outlined in
29-
[specification#1131](https://github.com/serverlessworkflow/specification/issues/1131) and further refined through MVP
29+
[serverlessworkflow/specification#1131](https://github.com/serverlessworkflow/specification/issues/1131) and further refined through MVP
3030
scoping discussions.
3131

3232
## Decision
3333

3434
After evaluating existing solutions, potential approaches, and their
3535
associated dependencies, we decided to build the editor from scratch to
36-
retain full ownership of the architecture and release process, prioritise
36+
retain full ownership of the architecture and release process, prioritize
3737
architectural simplicity, enable CNCF hosting and long-term sustainability,
3838
at the cost of slower initial delivery.
3939

@@ -51,14 +51,14 @@ vendor.
5151
### Proposed model
5252

5353
- Repository ownership
54-
- New repo under CNCF Workflow org, e.g. `workflow-spec-editor` (name TBD).
54+
- New repo under the CNCF Serverless Workflow Specification org, e.g. `workflow-spec-editor` (name TBD).
5555

5656
- Maintainers
5757

5858
- Initial maintainers: representatives from at least:
59-
- CNCF Workflow Spec maintainers
59+
- CNCF Serverless Workflow Specification maintainers
6060
- Quarkus Flow / SonataFlow
61-
- Other interested engine maintainers (e.g. Zigflow / Synapse / Lemline etc.).
61+
- Other interested engine maintainers (e.g. ZigFlow / Synapse / Lemline etc.).
6262

6363
- Decision process
6464

@@ -90,8 +90,8 @@ vendor.
9090
### 1. In Scope
9191

9292
- Read-only visual representation of YAML / JSON workflow definitions
93-
- Visualise all task types and transitions
94-
- Fully expanded nested task visualisation
93+
- Visualize all task types and transitions
94+
- Fully expanded nested task visualization
9595
- Indication of basic validation issues
9696
- Editor available via NPM package
9797
- A simple demo app showing how to embed the editor as a component
@@ -113,10 +113,11 @@ vendor.
113113

114114
### 4. Validation
115115

116-
- The editor assumes workflows provided by the backend are valid.
117-
- Edge cases to handle: validation discrepancies between the TypeScript SDK and the backend (runtime implementation).
118-
- If rendering is possible, display warnings as needed.
119-
- If rendering is not possible, provide clear error feedback to user.
116+
- The editor performs lightweight client-side schema/structural validation to determine whether the workflow can be rendered.
117+
- The backend (runtime implementation) remains the source of truth for full specification conformance and advanced validation rules.
118+
- Edge cases to handle: validation discrepancies between the TypeScript SDK and the backend (runtime implementation).
119+
- If structural validation passes and rendering is possible, render the workflow.
120+
- If structural validation fails and rendering is not possible, do not attempt to render a partial/invalid diagram; provide clear, actionable error feedback to the user instead.
120121

121122
### 5. Nested Tasks & Layout Strategy
122123

@@ -126,8 +127,8 @@ vendor.
126127

127128
### 6. Development & Tooling Decisions Overview (MVP)
128129

129-
- Web based implementation
130-
- React/TypeScript based architecture
130+
- Web-based implementation
131+
- React/TypeScript-based architecture
131132
- Diagram rendering via React Flow
132133
- Webpack for application bundling
133134
- Jest for unit testing
@@ -141,8 +142,8 @@ vendor.
141142

142143
### Positive
143144

144-
- CNCF aligned ownership
145-
- Lowers the entry barrier to the CNCF Serverless Workflow spec
145+
- CNCF-aligned ownership
146+
- Lowers the entry barrier to the CNCF Serverless Workflow Specification
146147
- Encourages understanding and usage of workflow semantics
147148
- Reduces duplicated tooling effort across runtimes
148149
- Provides a shared, consistent user experience

0 commit comments

Comments
 (0)