migration support for zeebe user tasks #4573
Conversation
christinaausley
added
component:docs
|
👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
@aleksander-dytko @volodymyr-melnykc How do you feel about me moving the migration manual to a new section? See related. If this is fine, I will apply it to 8.6 and 8.5 as well. Note that we still need to change the migration manual to the C8 API instead of the Zeebe REST API in both 8.6 and next. |
@christinaausley Moving the migration manual to a new dedicated section under the "APIs & Tools" makes sense to me. |
|
@volodymyr-melnykc I have started updating the endpoints in the Zeebe user task guide for the C8 API, but could you please make any final adjustments to the technical details you would like to make and I will backport? |
|
Note that @volodymyr-melnykc and I are syncing this week on plans for this and https://github.com/camunda/product-hub/issues/2126. |
| @@ -5,6 +5,12 @@ sidebar_position: 1 | |||
| description: "Build applications for human-centered processes by querying user tasks, assigning users, and completing tasks with the Tasklist API." | |||
| --- | |||
|
|
|||
| :::note | |||
| Camunda introduced the [Camunda 8 REST API](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md) with `8.6` to manage and query process entities such as processes, decisions, forms, and user tasks. | |||
There was a problem hiding this comment.
Is this still accurate @volodymyr-melnykc?
| @@ -5,6 +5,12 @@ sidebar_position: 1 | |||
| description: "Build applications for human-centered processes by querying human tasks, assigning users, and completing tasks with the Tasklist API." | |||
| --- | |||
|
|
|||
| :::note | |||
There was a problem hiding this comment.
Similar comment to double check here @volodymyr-melnykc.
There was a problem hiding this comment.
"Camunda introduced Zeebe user tasks with 8.5 to build more advanced functionalities. If you use Zeebe user tasks with 8.5, task management endpoints in the Tasklist API will not work.
To manage Zeebe user tasks Camunda has introduced the Zeebe REST API, though you can still query Zeebe user tasks with the Tasklist API."
|
@volodymyr-melnykc If this is accurate, this PR just requires your review and a few things to check for accuracy. Could you please ensure the migration guide (changed from Zeebe REST to C8) is up to date and accurate?
How would you like this to look in the documentation? |
|
@christinaausley will this be delivered with alpha2? Or still largely WIP? I'm trying to get a handle on when we can move forward with the API removal PRs (Zeebe REST API in this case). |
|
This can be merged as soon as @volodymyr-melnykc has a look -- he mentioned he will have time before the end of this week, so I can ensure the API removals also go out with the alpha next week. @akeller |
|
I'm reviewing it currently. |
|
@christinaausley I reviewed the changes (they looked good!) and updated several more details:
Please review! The doc for user task migration is called "migrate-to-zeeb-user-task.md". Since the implementation type is renamed to "Camunda user task", should we update the name of the file as well? cc @akeller |
@volodymyr-melnykc, just confirming, there will be no end user changes that we should document in this context for alpha2? I would love to see if get these docs in a good place to merge ASAP, or in this case, shortly after alpha2 if possible. We have many changes coming in alpha3 and the race to get things done for 8.7. If there is a way we can ship these docs changes incrementally to keep things moving, let's do that. |
|
Perhaps I did not communicate clearly enough in the PR description, but this PR is solely for changes with 8.5 and 8.6, which are changes that can likely already be merged in. I have plans to adjust all of the required changes in With this in mind, could you please review my changes to the versioned docs @volodymyr-melnykc? I will sift your additional changes in |
|
Changes specifically for Zeebe to Camunda user tasks will be covered in #4723, alongside the following: For 8.6
For 8.7
@volodymyr-melnykc Please review this PR -- my expectation is that all of these changes can go live and be merged now? Changes for Lastly, can your changes to the specifications be merged and live as well? Is this work already complete? If so, should this also be backported? Thank you for your assistance and apologies for the back and forth on this. |
|
@christinaausley Your changes look good and we can merge! The changes that I made are related to the ongoing updates in the product epic (https://github.com/camunda/product-hub/issues/2126). They're for the "next". I don't see risks in merging them as well, though there will be more follow-ups (which we can do later). |
versioned_docs/version-8.5/apis-tools/tasklist-api-rest/migrate-to-zeebe-user-tasks.md
Show resolved
Hide resolved
|
🧹 Preview environment for this PR has been torn down. |
Description
Relates to https://github.com/camunda/product-hub/issues/2126. Note that these are changes executing the following:
The following will be added in a separate PR:
For 8.6
For 8.7
E.g. this section needs to be updated: https://docs.camunda.io/docs/next/components/modeler/web-modeler/advanced-modeling/form-linking/#camunda-form-embedded
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).