Update "Get started with human task orchestration" guide to include Play #4401
Conversation
mesellings
added
kind/feature
mesellings
changed the title
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
@conceptualshark Don't worry, I'm going to rebase this and start again on Monday - I saw your changes, so I'll need to adapt the new stuff for this - don't spend any more time on it 😄 |
mesellings
removed
kind/feature
|
👋 🤖 🤔 Hello! 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. |
mesellings
added
kind/feature
mesellings
dismissed
conceptualshark’s stale review
Content has changed considerably after a merge conflict, it didn't need a review at this point
mesellings
added
deploy
|
Removing |
|
This needs a review by Eric, so should not be merged - was waiting for the deploy workflow to be fixed - we can hopefully push this tomorrow |
|
@HanselIdes The preview environment is (finally) fixed and up for you to review: Depending on when you are able to review, we can try to get this into the release tomorrow, or push it afterwards? |
There was a problem hiding this comment.
This is good progress, but fundamental updates to the user journey and differences between Desktop Modeler+C8 Run, Web Modeler SM, and Web Modeler SaaS make it difficult to follow the changes. It's probably best to group the tabs as
Desktop Modeler | Web Modeler
especially because we're uniting the UX between Web Modeler SaaS and SM
This complicates the flow and also the table of contents, where there are two step 4s
|
|
||
| import clsx from "clsx"; | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| import SaasPrereqs from './react-components/saas-prerequisites.md' | ||
| import Install from './react-components/install-c8run.md' | ||
|
|
||
| Camunda 8 allows you to orchestrate processes with human tasks of any complexity. Utilizing user tasks, you can create and assign tasks to users. Then, users can perform their work and enter the necessary data to drive the business process. | ||
| You can use Camunda 8 to orchestrate processes with human tasks of any complexity. User tasks allow you to create and assign tasks to users, who can then perform their work and enter the required data to drive the business process. |
There was a problem hiding this comment.
| You can use Camunda 8 to orchestrate processes with human tasks of any complexity. User tasks allow you to create and assign tasks to users, who can then perform their work and enter the required data to drive the business process. | |
| You can use Camunda 8 to orchestrate processes with human tasks of any complexity. Use the user task BPMN element to create and assign tasks to users, who can then perform their work and enter the required data to drive the business process. |
For the getting started with HTO guide, I'd also be interested in seeing @volodymyr-melnykc 's perspective as he's the HTO PM
| @@ -100,13 +139,14 @@ To run this guide, make sure to be in **Implement** mode to specify the technica | |||
|
|
|||
| 1. A **start event** is automatically added to the canvas. Click it to display configuration and append options. | |||
There was a problem hiding this comment.
The start event should be automatically selected- you can check this behavior on SaaS
| @@ -100,13 +139,14 @@ To run this guide, make sure to be in **Implement** mode to specify the technica | |||
|
|
|||
| 1. A **start event** is automatically added to the canvas. Click it to display configuration and append options. | |||
| 2. Click the rectangular **Append Task** icon to append a task. | |||
There was a problem hiding this comment.
These instructions should be updated to account for the new context pad. The user has to hover over the blue circle to the right, then click the rectangular append task icon. This applies for all instructions- they should be double-checked
| 2. Click the blue **link icon** in the lower right corner. A menu expands that allows you to create a new form. | ||
| <img src={ModelerFormMenuImg} style={{width: 400}} alt="Annotation to open the form menu" /> | ||
| 3. Click **Create new form**. A form will be created and opened in the form editor. The form is automatically named. | ||
| 1. Click the blue **link icon** in the lower right corner. A menu expands that allows you to create a new form. |
There was a problem hiding this comment.
I saw this instead of the empty state
| @@ -174,7 +213,7 @@ If the properties panel for your form doesn't open automatically, navigate to ** | |||
|
|
|||
| ## Step 3: Link the form to your process | |||
There was a problem hiding this comment.
If you create a form according to these instructions, then this step is automatically completed.
| First, you must create the BPMN diagram file and project. | ||
|
|
||
| 1. Open Web Modeler, and click **New project**. Every file in Web Modeler requires a project. | ||
| 2. Select **Create new > BPMN diagram**. |
There was a problem hiding this comment.
For automation, users should always use process applications. They have the most features, including a smoother Play deployment experience
|
|
||
| ### Deploy and test run | ||
| 1. Click the **Play** tab to enter Play mode. | ||
| 1. Once the Play environment is ready, click **Start a process instance** to start testing your process. |
There was a problem hiding this comment.
With 8.6, the user will need a cluster rather than just waiting for the Play environment.
| As well as using Play mode to quickly validate and run your process in development, you can also: | ||
|
|
||
| - Deploy the process to a [cluster](/components/concepts/clusters.md) in other environments such as testing, staging, and production. After you deploy your process, it can be run on the cluster. | ||
| - Run and complete the user task in [Tasklist](/components/tasklist/introduction-to-tasklist.md). Applications such as Tasklist can be used by humans to complete tasks. As well as using Play mode and Tasklist to run a process, you can call the process via the API or an inbound trigger. Read more about [run options](/components/modeler/web-modeler/run-or-publish-your-process.md). |
There was a problem hiding this comment.
You can follow a link to Operate...
and then a link to Tasklist if you have an open user task...
Or you can open Tasklist and it should show the open task directly
Thanks @HanselIdes I'll take another look at this - I really appreciate the comprehensive feedback 👍 |
|
The preview environment relating to the commit 49d0bd3 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4401/index.html |
|
@HanselIdes I've gone through the SaaS section and incorporated all your feedback - please check you are happy with the new structure, and I will move onto the SM section. https://preview.docs.camunda.cloud/pr-4401/docs/next/guides/orchestrate-human-tasks/
p.s. Ignore the right-hand menu for now, as it is still affected by the unchanged SM content. |
Description
Update the https://docs.camunda.io/docs/next/guides/orchestrate-human-tasks/ topic to include Play, milestone creation, and review as steps before running it on the cluster.
Relates to issue #4183.
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).