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.

Sign up for GitHub

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

Jump to bottom

draft bpmn copilot #4735

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

draft bpmn copilot #4735

wants to merge 2 commits into from
+56 −4

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Dec 9, 2024 •
edited
Loading

Description

Relates to feedback iteration of the Web Modeler BPMN copilot with https://github.com/camunda/product-hub/issues/2511.

Before merging, must confirm:

  • Screenshot is accurate based on product UI.
  • Links are provided for feedback and opting into the feature.
  • Confirmed this iteration is either alpha or experimental.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Dec 9, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 9, 2024

👋 🤖 🤔 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/.

  • docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md
  • docs/components/early-access/alpha/bpmn-copilot/img/bpmn-copilot-chat.png

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.

@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 20:04 Destroyed
@christinaausley christinaausley added the component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS label Dec 9, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 20:46 Destroyed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 9, 2024

The preview environment relating to the commit 02a3ff9 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4735/index.html

@ev-codes
Copy link
Contributor

Thanks @christinaausley ! I'll take a look at this later this week 😄

HanselIdes
HanselIdes reviewed Dec 12, 2024
View reviewed changes
Copy link
Contributor

@HanselIdes HanselIdes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ev-codes I added some thoughts. Please review them for accuracy and integrate them in. I do not need to re-review this doc

docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md
<span class="badge badge--cloud">Camunda 8 SaaS only</span>

:::note Terms of use
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
Camunda does not collect your prompts and the resulting BPMN diagrams.

@ev-codes to confirm

docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md
To use the BPMN copilot in Web Modeler, take the following steps:

1. Log in to [Web Modeler](/components/modeler/web-modeler/launch-web-modeler.md).
2. Click **New project > Create new > BPMN diagram**. If you have opted in to test this feature, the Camunda copilot chat window will pop up.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend adding a link to the opt in instructions

docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md
![bpmn copilot chat window](./img/bpmn-copilot-chat.png)

3. In the chat box, enter your prompt. This prompt should be a simple, clear, and concise request describing the BPMN diagram you would like to generate. For example, "Generate a mortgage loan process diagram". For more information, you can also ask questions like "How do I design a process?"
4. Wait for your diagram to generate; this takes about 50 seconds. Once complete, the copilot will then respond with an outline of the process it created.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a good point to mention the timeout

docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md

![bpmn copilot chat window](./img/bpmn-copilot-chat.png)

3. In the chat box, enter your prompt. This prompt should be a simple, clear, and concise request describing the BPMN diagram you would like to generate. For example, "Generate a mortgage loan process diagram". For more information, you can also ask questions like "How do I design a process?"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"simple, clear, and concise".
More complicated requests will take longer to process

docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md

3. In the chat box, enter your prompt. This prompt should be a simple, clear, and concise request describing the BPMN diagram you would like to generate. For example, "Generate a mortgage loan process diagram". For more information, you can also ask questions like "How do I design a process?"
4. Wait for your diagram to generate; this takes about 50 seconds. Once complete, the copilot will then respond with an outline of the process it created.
5. Review the generated diagram. If the diagram is not exact, you can continue chatting with the BPMN copilot by requesting changes or rephrasing your request. For example, "add exceptions". The new diagram will overwrite existing work, but the BPMN copilot will automatically generate a [milestone](/components/modeler/web-modeler/milestones.md) of the previous version, so you can return or revert to it anytime.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more complicated the existing diagram, the longer it will to complete the request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HanselIdes HanselIdes HanselIdes left review comments

@ev-codes ev-codes Awaiting requested review from ev-codes

@lmbateman lmbateman Awaiting requested review from lmbateman

At least 1 approving review is required to merge this pull request.

Assignees

@christinaausley christinaausley

Labels
component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS deploy Stand up a temporary docs site with this PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@christinaausley @ev-codes @HanselIdes