Add "Manage Connector Templates" docs #3420

YanaSegal · 2024-03-06T17:53:21Z

As part of https://github.com/camunda/product-hub/issues/1340 I am suggesting the following updates and changes for this page.

Add docs describing Shared Resources tab in SaaS web-modeler
Clarify existing docs about Connector templates shared with an organization

Closes https://github.com/camunda/team-connectors/issues/660

Description

When should this change go live?

This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
There is no urgency with this change.
This change or page is part of a marketing blog, conference talk, or something else on a schedule.
This functionality is already available but undocumented.
This is a bug fix or security concern.
This functionality will be available within the next week (in next web-modeler SaaS release), but we'd like documentation available at launch

PR Checklist

I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

As part of camunda/product-hub#1340 I am suggesting the following updates and changes for this page.

github-actions · 2024-03-06T17:53:46Z

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

docs/components/connectors/img/connector-templates/manage-connector-templates-no-org-privileges.png
docs/components/connectors/img/connector-templates/manage-connector-templates-org-privileges.png
docs/components/connectors/manage-connector-templates.md

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.

YanaSegal · 2024-03-06T17:55:03Z

@ev-codes I submitted my text changes. we still need to add the "Shared resources" screenshot.

as a stretch goal - we can update all screenshots on this page to be up-to-date.

docs/components/connectors/manage-connector-templates.md

github-actions · 2024-03-06T17:55:56Z

docs/components/connectors/manage-connector-templates.md


   ![Publishing a template](img/connector-templates/create-connector-template-3.png)

-   When using the Camunda 8 SaaS offering, as [organization owner or admin](/components/console/manage-organization/manage-users.md#users) you can publish a template version to the organization making it available to all projects in the organization.
-   To do so, either click **Publish > Publish to organization** on the Connector template editor screen or promote a template via the [Version History](#versioning-connector-templates).
+As [organization owner or admin](/components/console/manage-organization/manage-users.md#users), you can publish a Connector template version within the organization context, enabling all organization members to use it in their diagrams. 


[prettier] _{reported by reviewdog 🐶}

Suggested change

As [organization owner or admin](/components/console/manage-organization/manage-users.md#users), you can publish a Connector template version within the organization context, enabling all organization members to use it in their diagrams.

As [organization owner or admin](/components/console/manage-organization/manage-users.md#users), you can publish a Connector template version within the organization context, enabling all organization members to use it in their diagrams.

github-actions · 2024-03-06T17:55:56Z

docs/components/connectors/manage-connector-templates.md

   ![Promoting a template](img/connector-templates/create-connector-template-4.png)
+


[prettier] _{reported by reviewdog 🐶}

Suggested change

![Promoting a template](img/connector-templates/create-connector-template-4.png)

![Promoting a template](img/connector-templates/create-connector-template-4.png)

github-actions · 2024-03-06T17:55:56Z

docs/components/connectors/manage-connector-templates.md

+:::info Publishg to the organization is available for Camunda 8 SaaS only. :::
+
+### Manage published Connectors
+After publishing, a Connector template version can be applied across all models within the same project or organization, depending on its publication status. You can review the publication status of template versions in the [Version History](#versioning-connector-templates).


[prettier] _{reported by reviewdog 🐶}

Suggested change

After publishing, a Connector template version can be applied across all models within the same project or organization, depending on its publication status. You can review the publication status of template versions in the [Version History](#versioning-connector-templates).

After publishing, a Connector template version can be applied across all models within the same project or organization, depending on its publication status. You can review the publication status of template versions in the [Version History](#versioning-connector-templates).

github-actions · 2024-03-06T17:55:56Z

docs/components/connectors/manage-connector-templates.md

+On the modeler home page, you can find an overview of all shared resources within your organization. 
+Members without special permissions can view all the resources published within the organization. 


[prettier] _{reported by reviewdog 🐶}

Suggested change

On the modeler home page, you can find an overview of all shared resources within your organization.

Members without special permissions can view all the resources published within the organization.

On the modeler home page, you can find an overview of all shared resources within your organization.

Members without special permissions can view all the resources published within the organization.

christinaausley · 2024-04-01T13:50:48Z

@YanaSegal Will this go out with release next week?

YanaSegal · 2024-04-08T08:59:15Z

@christinaausley I guess not as the epic is not making it to the 8.5 release.

We only explain this in tooltips, which have limited space

YanaSegal · 2024-04-15T14:41:41Z

@akeller / @christinaausley
Reviewing the links of the "Versioning Connector templates" section exposes:

this document lives in Connectors
The link to Milestone points to web modeler documentation about milestones, but it does not mention the JSON editor milestones.
The link to "updating the version" redirects to desktop modeler documentation. but the feature we are adding is for SAAS only.

I don't have a solution but I wanted to highlight this issue.
Screenshot:

akeller · 2024-04-15T16:35:04Z

@YanaSegal this looks like feedback @ev-codes would implement in this PR. Or are you asking for assistance from DevEx?

If I'm following your comments correctly, we can add a SaaS-only badge. However, everything outside of the Self-Managed section is SaaS-first.

YanaSegal · 2024-04-16T11:16:01Z

Or are you asking for assistance from DevEx?

@akeller I am asking for your support as the links in the section I mentioned do not directly mention connectors or the editor. i think users that working on SaaS only, will be confused with seeing desktop modeler docs.
This is not blocking us, but makes sense to review it.

The "shared resources" feature is currently for SaaS only, but this may change in the future.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

docs/components/connectors/manage-connector-templates.md

ev-codes · 2024-04-16T13:50:19Z

@christinaausley may you please take a look at the docs in this PR?

This feature (and these docs) still need to go through the Connectors QA process before I merge, but I'd appreciate you taking a look before the QA process starts.

After your review (and I implement your suggestions), I will:

Start (and eventually complete) the QA process for this feature
Merge the feature into Web Modeler
Remove the "hold" label from this PR and merge after your approval

christinaausley · 2024-04-18T18:55:26Z

@ev-codes @YanaSegal This is wonderfully written! Some very small changes in my latest commits, but has my approval.

christinaausley · 2024-04-18T18:55:53Z

This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?

Shall we apply a hold label until this is ready for final approval?

ev-codes · 2024-04-19T08:15:04Z

@christinaausley Sure, I'll add the hold label now!

I had added one before, but removed it because it caused the "Enforce PR labels" check to fail.

christinaausley · 2024-04-19T15:41:16Z

@christinaausley Sure, I'll add the hold label now!

I had added one before, but removed it because it caused the "Enforce PR labels" check to fail.

Yeah, this is intentional so things don't get accidentally merged. We can remove and it will build clean once we are ready to merge this in 👍

ev-codes · 2024-04-26T10:33:38Z

@christinaausley this PR is fully ready now - may you please approve?

The code has been merged into web-modeler and should be released to SaaS customers sometime next week.

Since a link to this doc is prominently featured in the UI, I'd love to have these docs already available before the SaaS release if possible 😄

Update manage-connector-templates.md

93867fc

As part of camunda/product-hub#1340 I am suggesting the following updates and changes for this page.

YanaSegal added the component:connectors Issues related to the connectors project. label Mar 6, 2024

YanaSegal assigned ev-codes and YanaSegal Mar 6, 2024

github-actions bot reviewed Mar 6, 2024

View reviewed changes

akeller added the target:8.5 label Mar 12, 2024

christinaausley removed the target:8.5 label Apr 8, 2024

ev-codes added 8 commits April 12, 2024 11:13

Merge branch 'refs/heads/main' into YanaSegal-patch-1

557c71a

doc(shared-resources): fix minor grammar and formatting

d401b14

doc(shared-resources): clarify org permissions text

17b36de

doc(shared-resources): Make Connector template refs consistent

81db350

doc(shared-resources): Add more details re: source code permissions

100767c

We only explain this in tooltips, which have limited space

Merge branch 'refs/heads/main' into YanaSegal-patch-1

158a686

doc(shared-resources): Add changes for sync w/ Yana

df98fba

doc(shared-resources): Make version history naming consistent

b795245

ev-codes and others added 4 commits April 16, 2024 15:37

doc(shared-resources): Add screenshots

a31a777

doc(shared-resources): Update links

3152283

Apply suggestions from code review

f94189a

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Merge branch 'refs/heads/main' into YanaSegal-patch-1

4e6f2c6

github-actions bot reviewed Apr 16, 2024

View reviewed changes

docs/components/connectors/manage-connector-templates.md Show resolved Hide resolved

ev-codes added the hold This issue is parked, do not merge. label Apr 16, 2024

ev-codes marked this pull request as ready for review April 16, 2024 13:53

ev-codes removed the hold This issue is parked, do not merge. label Apr 16, 2024

ev-codes requested a review from christinaausley April 16, 2024 14:41

doc(shared-resources): Apply reviewdog feedback

b19e4c9

wollefitz mentioned this pull request Apr 17, 2024

Document Connector Templates and their use in Web Modeler #2314

Open

ev-codes and others added 3 commits April 17, 2024 14:19

Merge branch 'refs/heads/main' into YanaSegal-patch-1

d9a9190

style(formatting): technical review

dfbbf2b

minor typo

99860d9

ev-codes added 2 commits April 19, 2024 10:13

doc(shared-resources): Add missing "template"

a28394c

Merge branch 'refs/heads/main' into YanaSegal-patch-1

4eb56b9

ev-codes added the hold This issue is parked, do not merge. label Apr 19, 2024

ev-codes removed the hold This issue is parked, do not merge. label Apr 26, 2024

Merge branch 'refs/heads/main' into YanaSegal-patch-1

7a62422

ev-codes changed the title ~~Update manage-connector-templates.md~~ Add "Manage Connector Templates" docs Apr 26, 2024

christinaausley approved these changes Apr 26, 2024

View reviewed changes

christinaausley merged commit 220f07c into main Apr 26, 2024
8 checks passed

christinaausley deleted the YanaSegal-patch-1 branch April 26, 2024 15:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "Manage Connector Templates" docs #3420

Add "Manage Connector Templates" docs #3420

YanaSegal commented Mar 6, 2024 •

edited by ev-codes

Loading

github-actions bot commented Mar 6, 2024 •

edited

Loading

YanaSegal commented Mar 6, 2024

github-actions bot Mar 6, 2024

github-actions bot Mar 6, 2024

github-actions bot Mar 6, 2024

github-actions bot Mar 6, 2024

christinaausley commented Apr 1, 2024

YanaSegal commented Apr 8, 2024

YanaSegal commented Apr 15, 2024

akeller commented Apr 15, 2024

YanaSegal commented Apr 16, 2024 •

edited

Loading

ev-codes commented Apr 16, 2024 •

edited

Loading

christinaausley commented Apr 18, 2024

christinaausley commented Apr 18, 2024

ev-codes commented Apr 19, 2024

christinaausley commented Apr 19, 2024

ev-codes commented Apr 26, 2024

	As [organization owner or admin](/components/console/manage-organization/manage-users.md#users), you can publish a Connector template version within the organization context, enabling all organization members to use it in their diagrams.
	As [organization owner or admin](/components/console/manage-organization/manage-users.md#users), you can publish a Connector template version within the organization context, enabling all organization members to use it in their diagrams.

		![Promoting a template](img/connector-templates/create-connector-template-4.png)

	After publishing, a Connector template version can be applied across all models within the same project or organization, depending on its publication status. You can review the publication status of template versions in the [Version History](#versioning-connector-templates).

	After publishing, a Connector template version can be applied across all models within the same project or organization, depending on its publication status. You can review the publication status of template versions in the [Version History](#versioning-connector-templates).

		On the modeler home page, you can find an overview of all shared resources within your organization.
		Members without special permissions can view all the resources published within the organization.

Add "Manage Connector Templates" docs #3420

Add "Manage Connector Templates" docs #3420

Conversation

YanaSegal commented Mar 6, 2024 • edited by ev-codes Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Mar 6, 2024 • edited Loading

YanaSegal commented Mar 6, 2024

github-actions bot Mar 6, 2024

Choose a reason for hiding this comment

github-actions bot Mar 6, 2024

Choose a reason for hiding this comment

github-actions bot Mar 6, 2024

Choose a reason for hiding this comment

github-actions bot Mar 6, 2024

Choose a reason for hiding this comment

christinaausley commented Apr 1, 2024

YanaSegal commented Apr 8, 2024

YanaSegal commented Apr 15, 2024

akeller commented Apr 15, 2024

YanaSegal commented Apr 16, 2024 • edited Loading

ev-codes commented Apr 16, 2024 • edited Loading

christinaausley commented Apr 18, 2024

christinaausley commented Apr 18, 2024

ev-codes commented Apr 19, 2024

christinaausley commented Apr 19, 2024

ev-codes commented Apr 26, 2024

YanaSegal commented Mar 6, 2024 •

edited by ev-codes

Loading

github-actions bot commented Mar 6, 2024 •

edited

Loading

YanaSegal commented Apr 16, 2024 •

edited

Loading

ev-codes commented Apr 16, 2024 •

edited

Loading