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

Update Workflow API docs to stable #4411

Merged
merged 2 commits into from
Dec 3, 2024

Conversation

antontroshin
Copy link
Contributor

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Update documentation to use stable Workflow API

Issue reference

Related PR: dapr/dapr#8253

@antontroshin antontroshin requested review from a team as code owners October 30, 2024 18:30
@hhunter-ms
Copy link
Collaborator

The notes in the Workflow docs about Workflow being in beta also need removed:

Does the code snippet for the actor workflow backend need updated?: https://docs.dapr.io/reference/components-reference/supported-workflow-backend/actor-workflow-backend/

SDK docs and code snippets need updated as well, from each sdk repo:

@hhunter-ms hhunter-ms linked an issue Oct 31, 2024 that may be closed by this pull request
6 tasks
Copy link

github-actions bot commented Nov 6, 2024

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Nov 6, 2024
@github-actions github-actions bot closed this Nov 13, 2024
@hhunter-ms hhunter-ms removed the stale label Nov 18, 2024
@hhunter-ms hhunter-ms reopened this Nov 18, 2024
@antontroshin
Copy link
Contributor Author

Closing this PR for now, as the Workflows API in runtime will be deprecated and likely removed in the next releases.
Replaced by Workflows Client.

@msfussell msfussell reopened this Dec 3, 2024
@msfussell
Copy link
Member

This should not be closed. The docs need to show the final stable API. The beta API will be left there, but we will not mention this, only for transient compatibility until the v1.16 release.

@hhunter-ms
Copy link
Collaborator

merging this - @antontroshin I can address the rest of the workflow going stable updates mentioned in the comment above

@hhunter-ms hhunter-ms merged commit bf5e6fe into dapr:v1.15 Dec 3, 2024
4 checks passed
@antontroshin
Copy link
Contributor Author

@hhunter-ms @msfussell This PR merge should be reverted.
There's no Stable API update for Workflows /v1.0/workflow in the 1.15 release, as the entire workflow usage is now done through a separate Workflow Client.
As per support policy, the "old" /v1.0-beta1/workflow stays for a few releases until SDKs catch up in the new Workflow Client support implementation. Documentation, examples, and quickstarts for the new Workflow Client, are being updated in separate PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Workflow] Docs enhancements with stable release
3 participants