Basically, what you'd put in a 2-3 minute video, but in written form. DOES NOT cover setup or reproducibility by the user.
Tell a story: "We're an ISP/NREN. We have (IMS, deploy infra) etc. We want to develop a web service offering (un)subscribable products."
WFO does ... to connect them.
We define a Product ... a Step ... a Workflow. Subscriptions transition between lifecycle states via Workflows.
Provide screenshots of what each produces in the UI, and an example code snippet of each. Default the snippet to collapsed in the UI.
This should give operators a clear sense of what they'll see in the UI, and developers the option of seeing at a glance how they'll write workflows.
Alternative: one high-level crash course for everyone, then one lower-level crash course for developers that gives snippets to build the things in the previous crash course.
Basically, what you'd put in a 2-3 minute video, but in written form. DOES NOT cover setup or reproducibility by the user.
Tell a story: "We're an ISP/NREN. We have (IMS, deploy infra) etc. We want to develop a web service offering (un)subscribable products."
WFO does ... to connect them.
We define a Product ... a Step ... a Workflow. Subscriptions transition between lifecycle states via Workflows.
Provide screenshots of what each produces in the UI, and an example code snippet of each. Default the snippet to collapsed in the UI.
This should give operators a clear sense of what they'll see in the UI, and developers the option of seeing at a glance how they'll write workflows.
Alternative: one high-level crash course for everyone, then one lower-level crash course for developers that gives snippets to build the things in the previous crash course.