Skip to content

Commit

Permalink
template: add workflow description section
Browse files Browse the repository at this point in the history
Add a new section to the enhancement template to encourage enhancement
authors to explain how someone will use the feature they are
describing.

Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
  • Loading branch information
dhellmann committed Apr 18, 2022
1 parent 9c1658c commit 2c4f9bf
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions guidelines/enhancement_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,42 @@ bogged down.

Include a story on how this proposal will be operationalized: lifecycled, monitored and remediated at scale.

### Workflow Description

Explain how the user will use the feature. Be detailed and explicit.
Describe all of the actors, their roles, and the APIs or interfaces
involved. Define a starting state and then list the steps that the
user would need to go through to trigger the feature described in the
enhancement. Optionally add a
[mermaid](https://github.com/mermaid-js/mermaid#readme) sequence
diagram.

Use sub-sections to explain variations, such as for error handling,
failure recovery, or alternative outcomes.

Foe example:

**cluster creator** is a human user responsible for deploying a
cluster.

**application administrator** is a human user responsible for
deploying an application in a cluster.

1. The cluster creator sits down at their keyboard...
2. ...
3. The cluster creator sees that their cluster is ready to receive
applications, and gives the application administrator their
credentials.

#### Variation [optional]

If the cluster creator uses a standing desk, in step 1 above they can
stand instead of sitting down.

See
https://github.com/openshift/enhancements/blob/master/enhancements/workload-partitioning/management-workload-partitioning.md#high-level-end-to-end-workflow
and https://github.com/openshift/enhancements/pull/1067 for more detailed examples.

### API Extensions

API Extensions are CRDs, admission and conversion webhooks, aggregated API servers,
Expand Down

0 comments on commit 2c4f9bf

Please sign in to comment.