-
Notifications
You must be signed in to change notification settings - Fork 198
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FIrst documentation for Web Modeler (#620)
* docs(web-modeler): rough first update * docs(web-modeler): rename Cloud Modeler to Web Modeler and Camunda Modeler to Desktop Modeler * docs(web-modeler): rewrite launch-cloud-modeler.md page * docs(web-modeler): fix issues that ocurred after rebase * docs(web-modeler): rewrite model-your-first-diagram.md page * docs(web-modeler): rewrite import-diagram.md page * docs(web-modeler): rewrite save-and-deploy.md page * docs(web-modeler): rewrite start-instance.md page * docs(web-modeler): remove model-overview.md page * docs(web-modeler): document project roles and invitation * docs(web-modeler): finish docs for collaboration: folder, share, embed, comment, mention * docs(web-modeler): document milestones and diffing * docs(web-modeler): rewrite utilizing-forms.md page and use updated imgs * docs(web-modeler): rewrite automating-a-process-using-bpmn.md and use updated imgs * docs(web-modeler): rewrite getting-started-orchestrate-microservices.md and use updated imgs * docs(web-modeler): rewrite model-your-first-process.md and use updated imgs * docs(web-modeler): rewrite deploy-your-process-and-start-process-instance.md and use updated imgs * docs(web-modeler): rewrite implement-service-task.md and use updated imgs * docs(web-modeler): update implement-decision-gateway.md page and use updated imgs * docs(web-modeler): add supported browsers and cleanup unused images * docs(web-modeler): add news about web modeler and migration * docs(web-modeler): document canvas tools, real time collaboration and attention grabber * docs(redirects): support modeler rename * docs(redirects): add redirect for cloud modeler overview * docs(redirects): swap order * docs(web-modeler): add bpmn guide to next steps * docs(modeler): link to modeler about in bpmn-primer page * style(formatting): technical review of documentation * merge conflict with rename * docs(web-modeler): resolve review comments Co-authored-by: Amara <[email protected]> Co-authored-by: Christina Ausley <[email protected]>
- Loading branch information
1 parent
4c09969
commit b49cf0f
Showing
147 changed files
with
482 additions
and
239 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,3 +21,4 @@ npm-debug.log* | |
yarn-debug.log* | ||
yarn-error.log* | ||
node_modules | ||
/camunda-cloud-documentation.iml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file removed
BIN
-67.1 KB
...ponents/modeler/cloud-modeler/img/bpmn-diagrams-overview-with-context-menue.png
Binary file not shown.
Binary file removed
BIN
-40.3 KB
docs/components/modeler/cloud-modeler/img/bpmn-diagrams-overview.png
Binary file not shown.
Binary file removed
BIN
-58.8 KB
docs/components/modeler/cloud-modeler/img/cloud-modeler-add-endevent.png
Binary file not shown.
Binary file removed
BIN
-59.8 KB
docs/components/modeler/cloud-modeler/img/cloud-modeler-add-task.png
Binary file not shown.
Binary file removed
BIN
-87.8 KB
...ents/modeler/cloud-modeler/img/cloud-modeler-new-diagram-with-configuration.png
Binary file not shown.
Binary file removed
BIN
-57.2 KB
...mponents/modeler/cloud-modeler/img/cloud-modeler-new-diagram-with-end-event.png
Binary file not shown.
Binary file removed
BIN
-54.8 KB
...ponents/modeler/cloud-modeler/img/cloud-modeler-new-diagram-with-end-event2.png
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-58.6 KB
docs/components/modeler/cloud-modeler/img/save-and-deploy-successful.png
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-61.1 KB
docs/components/modeler/cloud-modeler/img/start-process-instance-done.png
Binary file not shown.
Binary file removed
BIN
-72 KB
docs/components/modeler/cloud-modeler/img/start-process-instance-variables.png
Binary file not shown.
This file was deleted.
Oops, something went wrong.
15 changes: 0 additions & 15 deletions
15
docs/components/modeler/cloud-modeler/launch-cloud-modeler.md
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
18 changes: 0 additions & 18 deletions
18
docs/components/modeler/cloud-modeler/model-your-first-diagram.md
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
--- | ||
id: collaboration | ||
title: Collaboration | ||
description: Collaboration features and access rights for Web Modeler. | ||
--- | ||
|
||
## Projects | ||
|
||
Files and folders are stored in projects. | ||
The user access on files and folders is defined at the project level. | ||
|
||
When you access Web Modeler via the Cloud menu, you see the **Home** page with all the projects you can access: | ||
 | ||
|
||
### Access rights and permissions | ||
|
||
Users can have various levels of access to a project in Web Modeler, outlined in this section. | ||
|
||
After creating a project, you can invite members of your Camunda Cloud organization to collaborate in Web Modeler. | ||
There are four roles with different levels of access rights that can be assigned to each user: | ||
|
||
* **Project Admin**: The user can edit the project itself, all folders and diagrams within the project, and invite more users to collaborate. | ||
* **Editor**: The user can edit all folders and diagrams within the project. | ||
* **Commenter**: the user cannot edit folders or diagrams nor invite users, but can view and leave comments on diagrams. | ||
* **Viewer**: The user cannot edit folders or diagrams nor leave comments, but can only view diagrams. | ||
|
||
### Inviting users to projects | ||
|
||
On the right side of a project, view a list of your collaborators and invite more by taking the steps below: | ||
|
||
1. Click **Add User**. | ||
 | ||
|
||
2. Choose a role for your new collaborator. | ||
 | ||
|
||
3. Begin typing the name of the individual and Web Modeler will suggest Camunda Cloud organization members that you can invite to the project. | ||
 | ||
|
||
4. Write a message to your new collaborator about their invitation to the project. | ||
 | ||
|
||
5. Click **Send** and your new collaborator will receive an email with the invitation. | ||
 | ||
 | ||
|
||
### Folders | ||
|
||
You can create folders in a project to semantically group and organize your diagrams. | ||
The user access on a folder is inherited from the project. | ||
|
||
## Sharing and embedding diagrams | ||
|
||
Diagrams can also be shared with others in read-only mode via a sharing link. | ||
This link can also be protected with an additional password. | ||
|
||
1. Navigate to a diagram and click on the share icon button. | ||
 | ||
|
||
2. Click **Create link**. | ||
 | ||
|
||
1. Click **Copy** to copy the link to your clipboard. | ||
 | ||
|
||
1. Click **Add** and type a new password to protect your link. | ||
 | ||
|
||
5. Click **Email** to share the new link with multiple recipients. | ||
 | ||
|
||
Similar to the sharing link, a diagram can be embedded into HTML pages via an iframe tag. The iframe tag can be copied from the sharing dialog via the **Embed** button. | ||
|
||
For wiki systems like [Confluence](https://www.atlassian.com/software/confluence), we recommend using the HTML macro and adding the iframe tag from the sharing dialog. This way, diagrams can be easily included in documentation pages. To adjust the dimensions of the diagram, the width and height values of the iframe tag can be modified. | ||
|
||
## Comments | ||
|
||
When selecting an element of the BPMN diagram, a discussion can be attached to this element. If no element is selected, the discussion will be attached directly to the diagram. | ||
Switch between the **Properties Panel** and **Comments** using the two tabs present at the top of the right side panel. | ||
 | ||
|
||
New comments can be added to the discussion by any collaborator with Admin, Editor, or Commenter access rights. | ||
|
||
Afterwards, the comment can be edited or deleted via the context menu icon. | ||
 | ||
|
||
Elements with discussions attached will always have a visible blue overlay, so you can easily identify discussion points. | ||
 | ||
|
||
### Mention others in comments | ||
|
||
By typing the **@** character, you are able to filter the collaborators on the project and select one of them. | ||
 | ||
|
||
When submitting the comment, this user will receive an email as a notification about the new comment. | ||
 | ||
|
||
## Interact with your collaborators | ||
|
||
### Model a diagram together | ||
|
||
When others are opening the same diagram as you, the updates on the diagram are sent in real time. You can also see who is in the diagram with you. | ||
 | ||
|
||
### Draw other's attention | ||
|
||
Whether you are in a presentation or if others are in the same diagram as you are, use the attention grabber pointer to draw attention to a specific part of the diagram. To do this, take the following steps: | ||
|
||
1. Switch on the attention grabber pointer from the canvas tools. | ||
 | ||
|
||
2. Drop the pointer by clicking anywhere on the canvas. | ||
 | ||
|
||
The pointer will pulsate to draw attention and will match your avatar color. | ||
It can also be seen in real-time by others that are looking at the same diagram as you. |
Binary file added
BIN
+2.27 MB
docs/components/modeler/web-modeler/img/attention-grabber-pointer-pulse.gif
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+386 KB
docs/components/modeler/web-modeler/img/cloud-web-modeler-menu-item.png
Oops, something went wrong.
Binary file added
BIN
+268 KB
...r/web-modeler/img/collaboration/web-modeler-collaborator-invite-choose-role.png
Oops, something went wrong.
Binary file added
BIN
+209 KB
...modeler/web-modeler/img/collaboration/web-modeler-collaborator-invite-email.png
Oops, something went wrong.
Binary file added
BIN
+318 KB
.../web-modeler/img/collaboration/web-modeler-collaborator-invite-modal-opened.png
Oops, something went wrong.
Binary file added
BIN
+240 KB
.../modeler/web-modeler/img/collaboration/web-modeler-collaborator-invite-sent.png
Oops, something went wrong.
Binary file added
BIN
+240 KB
...r/web-modeler/img/collaboration/web-modeler-collaborator-invite-suggestions.png
Oops, something went wrong.
Binary file added
BIN
+263 KB
.../web-modeler/img/collaboration/web-modeler-collaborator-invite-type-message.png
Oops, something went wrong.
Binary file added
BIN
+194 KB
...nts/modeler/web-modeler/img/collaboration/web-modeler-comment-mention-email.png
Oops, something went wrong.
Binary file added
BIN
+312 KB
...deler/web-modeler/img/collaboration/web-modeler-comment-mention-suggestions.png
Oops, something went wrong.
Binary file added
BIN
+246 KB
...odeler/web-modeler/img/collaboration/web-modeler-comment-overlay-on-diagram.png
Oops, something went wrong.
Binary file added
BIN
+270 KB
...ponents/modeler/web-modeler/img/collaboration/web-modeler-comment-type-here.png
Oops, something went wrong.
Binary file added
BIN
+264 KB
...modeler/web-modeler/img/collaboration/web-modeler-comment-with-context-menu.png
Oops, something went wrong.
Binary file added
BIN
+218 KB
docs/components/modeler/web-modeler/img/collaboration/web-modeler-home.png
Oops, something went wrong.
Binary file added
BIN
+239 KB
...ponents/modeler/web-modeler/img/collaboration/web-modeler-share-icon-button.png
Oops, something went wrong.
Binary file added
BIN
+321 KB
...onents/modeler/web-modeler/img/collaboration/web-modeler-share-modal-create.png
Oops, something went wrong.
Binary file added
BIN
+308 KB
...ponents/modeler/web-modeler/img/collaboration/web-modeler-share-modal-email.png
Oops, something went wrong.
Binary file added
BIN
+297 KB
...eler/web-modeler/img/collaboration/web-modeler-share-modal-password-protect.png
Oops, something went wrong.
Binary file added
BIN
+267 KB
docs/components/modeler/web-modeler/img/collaboration/web-modeler-share-modal.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+224 KB
...eb-modeler/img/import-diagram/web-modeler-diagram-replace-via-drag-and-drop.png
Oops, something went wrong.
Binary file added
BIN
+183 KB
...ts/modeler/web-modeler/img/import-diagram/web-modeler-project-drag-and-drop.png
Oops, something went wrong.
Binary file added
BIN
+468 KB
...odeler/web-modeler/img/import-diagram/web-modeler-replace-via-upload-choose.png
Oops, something went wrong.
Binary file added
BIN
+270 KB
...ler/web-modeler/img/import-diagram/web-modeler-replace-via-upload-menu-item.png
Oops, something went wrong.
Binary file added
BIN
+431 KB
...nents/modeler/web-modeler/img/import-diagram/web-modeler-upload-file-choose.png
Oops, something went wrong.
Binary file added
BIN
+244 KB
...ts/modeler/web-modeler/img/import-diagram/web-modeler-upload-file-completed.png
Oops, something went wrong.
Binary file added
BIN
+226 KB
...ts/modeler/web-modeler/img/import-diagram/web-modeler-upload-file-menu-item.png
Oops, something went wrong.
Binary file added
BIN
+215 KB
.../modeler/web-modeler/img/milestones/web-modeler-milestone-clock-icon-button.png
Oops, something went wrong.
Binary file added
BIN
+228 KB
...eler/web-modeler/img/milestones/web-modeler-milestone-create-via-breadcrumb.png
Oops, something went wrong.
Binary file added
BIN
+204 KB
...ts/modeler/web-modeler/img/milestones/web-modeler-milestone-create-via-icon.png
Oops, something went wrong.
Binary file added
BIN
+202 KB
...components/modeler/web-modeler/img/milestones/web-modeler-milestone-diffing.png
Oops, something went wrong.
Binary file added
BIN
+233 KB
...s/modeler/web-modeler/img/milestones/web-modeler-milestone-restore-complete.png
Oops, something went wrong.
Binary file added
BIN
+211 KB
...components/modeler/web-modeler/img/milestones/web-modeler-milestone-restore.png
Oops, something went wrong.
Binary file added
BIN
+225 KB
.../components/modeler/web-modeler/img/milestones/web-modeler-related-diagrams.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+181 KB
...s/modeler/web-modeler/img/new-web-modeler/web-modeler-home-migrated-project.png
Oops, something went wrong.
Binary file added
BIN
+331 KB
...modeler/img/new-web-modeler/web-modeler-project-migrated-diagrams-and-forms.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+230 KB
docs/components/modeler/web-modeler/img/save-and-deploy-successful.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+238 KB
docs/components/modeler/web-modeler/img/start-process-instance-done.png
Oops, something went wrong.
Binary file added
BIN
+386 KB
docs/components/modeler/web-modeler/img/start-process-instance-variables.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+372 KB
docs/components/modeler/web-modeler/img/web-modeler-deploy-modal-healthy.png
Oops, something went wrong.
Binary file added
BIN
+331 KB
...mponents/modeler/web-modeler/img/web-modeler-new-diagram-with-configuration.png
Oops, something went wrong.
Binary file added
BIN
+211 KB
...onents/modeler/web-modeler/img/web-modeler-new-user-new-diagram-choose-bpmn.png
Oops, something went wrong.
Binary file added
BIN
+414 KB
docs/components/modeler/web-modeler/img/web-modeler-new-user-new-diagram-modal.png
Oops, something went wrong.
Binary file added
BIN
+227 KB
docs/components/modeler/web-modeler/img/web-modeler-new-user-new-diagram.png
Oops, something went wrong.
Binary file added
BIN
+196 KB
docs/components/modeler/web-modeler/img/web-modeler-new-user-new-project.png
Oops, something went wrong.
Binary file added
BIN
+342 KB
...components/modeler/web-modeler/img/web-modeler-start-instance-modal-healthy.png
Oops, something went wrong.
Binary file added
BIN
+274 KB
docs/components/modeler/web-modeler/img/web-modeler-with-end-event.png
Oops, something went wrong.
Binary file added
BIN
+242 KB
docs/components/modeler/web-modeler/img/web-modeler-with-end-event2.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: import-diagram | ||
title: Import diagram | ||
description: "You can import a BPMN diagram at any time with Web Modeler." | ||
--- | ||
|
||
You can import a BPMN diagram at any time with Web Modeler, and there are several ways to accomplish this: | ||
|
||
- In a project, click **New > Upload files** and select the files from your computer. | ||
 | ||
 | ||
 | ||
|
||
- In a project, drag one file from your computer and drop it. | ||
 | ||
|
||
- In a diagram, open the breadcrumb menu and choose **Replace via upload**. Then, select a file from your computer. | ||
|
||
 | ||
 | ||
|
||
- In a diagram, drag one file from your computer and drop it onto the canvas. | ||
 | ||
|
||
:::note | ||
Within the last two options above, note that the content of the diagram will be replaced with the content of the file. | ||
::: |
Oops, something went wrong.