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

chore(context-pad): document as non-alpha feature #4002

Merged
merged 6 commits into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Use the new refactoring suggestions feature to improve your BPMN di
<span class="badge badge--alpha">Alpha</span>

:::note
Refactoring suggestions are an alpha feature. To use this feature, enable the [context pad](/components/modeler/web-modeler/new-context-pad.md) and [AI-powered features](https://camunda.com/blog/2024/02/camunda-docs-ai-developer-experience-new-level/) through the [alpha features](/components/console/manage-organization/enable-alpha-features.md) menu.
Refactoring suggestions are an alpha feature. To use this feature, enable the [context pad](/components/modeler/web-modeler/context-pad.md) and [AI-powered features](https://camunda.com/blog/2024/02/camunda-docs-ai-developer-experience-new-level/) through the [alpha features](/components/console/manage-organization/enable-alpha-features.md) menu.
:::

The refactoring suggestions feature helps you improve your BPMN diagrams by providing suggestions for refactoring your diagrams based on best practices and common patterns. You can access the refactoring suggestions by clicking on the AI **Show suggestions** icon in the context pad:
Expand Down
25 changes: 25 additions & 0 deletions docs/components/modeler/web-modeler/context-pad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: context-pad
title: Context pad
description: The context pad is a feature that allows you to add elements to your diagram and perform actions on elements.
---

The context pad is one of the main ways to interact with the diagram. Actions that change the selected element can be found in the context pad above the selected elements while actions that append or attach new elements are accessible through the plus icons.

![context pad overview](img/context-pad/overview.png)

The **append feature** is separated from the context pad and allows you to append any element directly without having to change the type of the element you just appended:

![append element icon](img/context-pad/append-element.png)

The **attach feature** lets you attach boundary events with one click:

![append boundary event](img/context-pad/append-boundary-event.png)

**Linking resources** like BPMN elements, DMN elements, and forms can also be done through the context pad:

![link form](img/context-pad/linking.png)

Finally, **comments** can be toggled through the context pad:

![show comments icon](img/context-pad/comments.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
36 changes: 0 additions & 36 deletions docs/components/modeler/web-modeler/new-context-pad.md

This file was deleted.

2 changes: 1 addition & 1 deletion optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ module.exports = {
),
docsLink(
"Context pad",
"components/modeler/web-modeler/new-context-pad/"
"components/modeler/web-modeler/context-pad/"
),
docsLink(
"Import diagram",
Expand Down
2 changes: 1 addition & 1 deletion optimize_versioned_sidebars/version-3.13.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@
{
"type": "link",
"label": "Context pad",
"href": "/docs/components/modeler/web-modeler/new-context-pad/"
"href": "/docs/components/modeler/web-modeler/context-pad/"
},
{
"type": "link",
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ module.exports = {
"Web Modeler": [
"components/modeler/web-modeler/launch-web-modeler",
"components/modeler/web-modeler/model-your-first-diagram",
"components/modeler/web-modeler/new-context-pad",
"components/modeler/web-modeler/context-pad",
"components/modeler/web-modeler/import-diagram",
"components/modeler/web-modeler/fix-problems-in-your-diagram",
"components/modeler/web-modeler/run-or-publish-your-process",
Expand Down
3 changes: 3 additions & 0 deletions static/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L]
# Disable directory listing and multi views
Options -Indexes -MultiViews

# redirect new-context-pad to context-pad
RewriteRule ^docs/components/modeler/web-modeler/new-context-pad/?$ /docs/components/modeler/web-modeler/context-pad/$1 [R=301,L]

# Move Help Center
RewriteRule ^docs/guides/camunda-help-center/(.*)$ /docs/reference/camunda-help-center/$1 [R=301,L]
RewriteRule ^docs/8.5/guides/camunda-help-center/(.*)$ /docs/8.5/reference/camunda-help-center/$1 [R=301,L]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Use the new refactoring suggestions feature to improve your BPMN di
<span class="badge badge--alpha">Alpha</span>

:::note
Refactoring suggestions are an alpha feature. To use this feature, enable the [context pad](/components/modeler/web-modeler/new-context-pad.md) and [AI-powered features](https://camunda.com/blog/2024/02/camunda-docs-ai-developer-experience-new-level/) through the [alpha features](/components/console/manage-organization/enable-alpha-features.md) menu.
Refactoring suggestions are an alpha feature. To use this feature, enable the [context pad](/components/modeler/web-modeler/context-pad.md) and [AI-powered features](https://camunda.com/blog/2024/02/camunda-docs-ai-developer-experience-new-level/) through the [alpha features](/components/console/manage-organization/enable-alpha-features.md) menu.
:::

The refactoring suggestions feature helps you improve your BPMN diagrams by providing suggestions for refactoring your diagrams based on best practices and common patterns. You can access the refactoring suggestions by clicking on the AI **Show suggestions** icon in the context pad:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: context-pad
title: Context pad
description: The context pad is a feature that allows you to add elements to your diagram and perform actions on elements.
---

The context pad is one of the main ways to interact with the diagram. Actions that change the selected element can be found in the context pad above the selected elements while actions that append or attach new elements are accessable through the plus icons.

![context pad overview](img/context-pad/overview.png)

The **append feature** is separated from the context pad and allows you to append any element directly without having to change the type of the element you just appended:

![append element icon](img/context-pad/append-element.png)

The **attach feature** lets you attach boundary events with one click:

![append boundary event](img/context-pad/append-boundary-event.png)

**Linking resources** like BPMN elements, DMN elements, and forms can also be done through the context pad:

![link form](img/context-pad/linking.png)

Finally, **comments** can be toggled through the context pad:

![show comments icon](img/context-pad/comments.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

This file was deleted.

2 changes: 1 addition & 1 deletion versioned_sidebars/version-8.5-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
"Web Modeler": [
"components/modeler/web-modeler/launch-web-modeler",
"components/modeler/web-modeler/model-your-first-diagram",
"components/modeler/web-modeler/new-context-pad",
"components/modeler/web-modeler/context-pad",
"components/modeler/web-modeler/import-diagram",
"components/modeler/web-modeler/fix-problems-in-your-diagram",
"components/modeler/web-modeler/run-or-publish-your-process",
Expand Down
Loading