-
Notifications
You must be signed in to change notification settings - Fork 197
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
Update Desktop Modeler connector template documentation #4187
Merged
Merged
Changes from 17 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
7e9b46a
FOOP: UPDATE CONNECTORS
nikku cdb0bed
Update use-connectors.md
nikku 56cc1eb
Automatic fetching of templates is now enabled per default
nikku f6d1fcc
Update docs/components/modeler/desktop-modeler/use-connectors.md
nikku 90f6cf0
Update use-connectors.md
nikku 2d24245
SAD
nikku afeca19
chore: backport to v8.5
nikku d82bd8e
GRAMMAR UP Update use-connectors.md
nikku 0c69b27
chore: rename flag to `disable-connector-templates`
nikku 2507697
chore: add missing images
nikku d01bebb
Update versioned_docs/version-8.5/components/modeler/desktop-modeler/…
nikku caa3a23
Update docs/components/modeler/desktop-modeler/use-connectors.md
nikku 8a83453
Update versioned_docs/version-8.5/components/modeler/desktop-modeler/…
nikku 7344614
Update docs/components/modeler/desktop-modeler/flags/flags.md
nikku 27d56e0
chore: clearly disambiguate element templates vs. conenctors
nikku 651bb29
Update use-connectors.md
nikku 27cabcd
restructure content, edits
conceptualshark 98f5815
chore: propose release-notes update
nikku 5c846b4
chore: restore marketplace link
nikku e6e50a4
Update docs/reference/release-notes/860.md
nikku File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 added
BIN
+96 KB
...ocs/version-8.5/components/modeler/desktop-modeler/img/use-connectors/apply.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+62.8 KB
...ocs/version-8.5/components/modeler/desktop-modeler/img/use-connectors/error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+57.1 KB
...ersion-8.5/components/modeler/desktop-modeler/img/use-connectors/up-to-date.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions
41
versioned_docs/version-8.5/components/modeler/desktop-modeler/use-connectors.md
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,41 @@ | ||
--- | ||
id: use-connectors | ||
title: Use Connectors | ||
description: "Learn how to use Camunda 8 Connectors in Desktop Modeler." | ||
--- | ||
|
||
<span class="badge badge--cloud">Camunda 8 only</span> | ||
|
||
Use [Camunda 8 Connectors](../../connectors/introduction.md) to access a growing range of external services or communication protocols. | ||
|
||
Desktop Modeler automatically fetches and updates [element templates](./element-templates/about-templates.md) for [pre-built Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) from the [Camunda Marketplace](https://marketplace.camunda.com/en-US/listing?pl=3038&attr=20486&cat=107792&locale=en-US). This happens automatically, in the background, unless explicitly [disabled](#disable-automatic-connector-template-fetching). Connector templates can also be provided [manually](#add-connector-templates-manually), offering you full control over the building blocks provided by the modeler. | ||
|
||
## Automatic Connector template fetching | ||
|
||
Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors. | ||
|
||
After an update check has concluded, a notification indicates if the templates are up to date or have been updated: | ||
|
||
 | ||
|
||
In case of an error you'll see a notification: | ||
|
||
 | ||
|
||
Once fetched, you can use the templates in the Camunda 8 BPMN editor. | ||
|
||
 | ||
|
||
## Disable automatic Connector template fetching | ||
|
||
Disable automatic fetching of Connector templates using the `#disable-connector-templates` [feature flag](./flags/flags.md#disable-connector-templates). | ||
|
||
## Add Connector templates manually | ||
|
||
For full control over the building blocks offered by Desktop Modeler, download element templates for individual Camunda 8 Connectors manually (for example, through the [Camunda Marketplace](/components/modeler/web-modeler/camunda-marketplace.md)). Make them available to Desktop Modeler via the element template [search paths](./element-templates/configuring-templates.md). | ||
|
||
## Additional resources | ||
|
||
- [About Camunda 8 Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) | ||
- [About Element Templates](./element-templates/about-templates.md) | ||
- [Desktop Modeler flags](./flags/flags.md#disable-connector-templates) |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@conceptualshark I believe we should revert this change of the link.
From the Desktop Modeler the market place is not available as shown in the linked URL, nor is any of the "integrated UI".