Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Workflow] Make sure all capabilities are documented (purge, etc) #4003

Closed
hhunter-ms opened this issue Feb 2, 2024 · 1 comment · Fixed by #4020
Closed

[Workflow] Make sure all capabilities are documented (purge, etc) #4003

hhunter-ms opened this issue Feb 2, 2024 · 1 comment · Fixed by #4020
Assignees
Labels
content/missing-information More information requested or needed
Milestone

Comments

@hhunter-ms
Copy link
Collaborator

What content needs to be created or modified?
Need more documentation about purge capability for workflow in the features/concepts doc. May also need to add other capabilities that haven't been documented.

Describe the solution you'd like
Section/paragraph, bullet list, cross linking

Where should the new material be placed?
Workflow features and concepts

The associated pull request from dapr/dapr, dapr/components-contrib, or other Dapr code repos
As mentioned in a comment here: #3969

@hhunter-ms hhunter-ms added the content/missing-information More information requested or needed label Feb 2, 2024
@hhunter-ms hhunter-ms self-assigned this Feb 2, 2024
@msfussell
Copy link
Member

msfussell commented Feb 6, 2024

Specifically I would add the following

  1. Before this section https://docs.dapr.io/developing-applications/building-blocks/workflow/workflow-features-concepts/#limitations add a title called "Purging" with text something like this
    "Workflow state can be purged from a state store for which purges all its history and removes all metadata related to a specific workflow instance. This is typically used for workflows that have run to a COMPLETED or TERMINATED state. Purging is also performed when a workflow moves to a CONTINUED_AS_NEW state. There are of course other times that you may choose to purge a workflow history and reuse a workflow instance with new inputs, for example with a FAILED workflow instance"

  2. In the https://docs.dapr.io/developing-applications/building-blocks/workflow/workflow-architecture/#state-store-usage section add that "Workflow state can be purged from a state store for which purges all its history. Purging removes all metadata related to a specific workflow instance"

I would get @cgillum to review this text suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content/missing-information More information requested or needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants