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

Console Manage connectors #5363

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Console Manage connectors #5363

wants to merge 9 commits into from

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Mar 25, 2025

Description

Add docs for #5362.

When should this change go live?

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

PR Checklist

  • My changes are for an upcoming minor release and:
    • are in the /docs directory (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@mesellings mesellings added kind/feature Issues related with features to be documented component:console Issues related with Console project component:connectors Issues related to the connectors project. target:8.7 Issues included in the 8.7 release deploy Stand up a temporary docs site with this PR labels Mar 25, 2025
@mesellings mesellings self-assigned this Mar 25, 2025
@mesellings mesellings linked an issue Mar 25, 2025 that may be closed by this pull request
Copy link
Contributor

github-actions bot commented Mar 25, 2025

👋 🤖 🤔 Hello, @mesellings! 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/console/manage-clusters/img/cluster-connector-instance-details.png
  • docs/components/console/manage-clusters/img/cluster-connector-instance-error.png
  • docs/components/console/manage-clusters/img/cluster-connector-management-page.png
  • docs/components/console/manage-clusters/img/cluster-connector-process-details.png
  • docs/components/console/manage-clusters/img/cluster-manage-connectors.png
  • docs/components/console/manage-clusters/manage-connectors.md
These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in versioned_docs/version-8.6/.
  • versioned_docs/version-8.7/components/console/manage-clusters/img/cluster-connector-instance-details.png
  • versioned_docs/version-8.7/components/console/manage-clusters/img/cluster-connector-instance-error.png
  • versioned_docs/version-8.7/components/console/manage-clusters/img/cluster-connector-management-page.png
  • versioned_docs/version-8.7/components/console/manage-clusters/img/cluster-connector-process-details.png
  • versioned_docs/version-8.7/components/console/manage-clusters/img/cluster-manage-connectors.png
  • versioned_docs/version-8.7/components/console/manage-clusters/manage-connectors.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.

@github-actions github-actions bot temporarily deployed to camunda-docs March 25, 2025 16:24 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs March 25, 2025 17:17 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs March 26, 2025 11:29 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs March 26, 2025 17:15 Destroyed
@mesellings mesellings marked this pull request as ready for review March 27, 2025 10:00
@mesellings mesellings added the hold This issue is parked, do not merge. label Mar 27, 2025
@mesellings mesellings requested review from johnBgood and a team March 27, 2025 10:01
@github-actions github-actions bot temporarily deployed to camunda-docs March 27, 2025 10:10 Destroyed
@mesellings
Copy link
Contributor Author

@johnBgood Here is a first draft for you - please add any further technical details you think might be needed, and also let me know whether this needs to be backported - currently I've added it for 8.7 & 8.8 👍

@mesellings mesellings changed the title WIP: Console Manage connectors Console Manage connectors Mar 27, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs March 27, 2025 10:19 Destroyed
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Just a few miscellaneous comments. Nice, clean writing!

@mesellings
Copy link
Contributor Author

mesellings commented Mar 27, 2025

Thanks for the review @christinaausley - incorporated all your comments! 🚀

@mesellings
Copy link
Contributor Author

@johnBgood This PR is probably ready for your approval - you can view it at https://preview.docs.camunda.cloud/pr-5363/docs/8.7/components/console/manage-clusters/cluster-connectors/

Note: Just need to know if this needs to be backported for any other versions - currently only on 8.7 and 8.8.

@github-actions github-actions bot temporarily deployed to camunda-docs March 27, 2025 15:58 Destroyed
johnBgood
johnBgood previously approved these changes Mar 27, 2025
Copy link
Contributor

@johnBgood johnBgood left a comment

Choose a reason for hiding this comment

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

I left a few comments, but happy to approve. Great stuff!

@johnBgood johnBgood requested a review from sbuettner March 27, 2025 16:04
@johnBgood
Copy link
Contributor

I added @sbuettner as a reviewer just so that he's aware of the content

@mesellings
Copy link
Contributor Author

Thanks @johnBgood I've committed the changes following your review, if you're happy please can I get another approval?

  • Is this just for 8.7 and 8.8?
  • Does it need to wait to be published closer to the release, or are you happy for it to go out tomorrow for example?

@github-actions github-actions bot temporarily deployed to camunda-docs March 27, 2025 17:17 Destroyed
Copy link
Contributor

@johnBgood johnBgood left a comment

Choose a reason for hiding this comment

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

🥇

@johnBgood
Copy link
Contributor

johnBgood commented Mar 27, 2025

@mesellings

Is this just for 8.7 and 8.8?

Yes

Does it need to wait to be published closer to the release, or are you happy for it to go out tomorrow for example?

I'd say we can publish at the end of next week, close to the release

@github-actions github-actions bot temporarily deployed to camunda-docs March 28, 2025 07:20 Destroyed
Copy link
Contributor

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

@mesellings
Copy link
Contributor Author

@johnBgood As per the comments in https://github.com/camunda/product-hub/issues/2750, should we remove this from the 8.7 docs, as it looks like it is only meant for 8.8-alpha3?

@johnBgood
Copy link
Contributor

johnBgood commented Mar 28, 2025

@mesellings nope, the epic you mentioned is just about adding the multiple runtime support, which is not present currently. But we will still release Manage and Run without this feature (in 8.7 + latest alpha)

@mesellings
Copy link
Contributor Author

Great thanks @johnBgood 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:connectors Issues related to the connectors project. component:console Issues related with Console project deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. kind/feature Issues related with features to be documented target:8.7 Issues included in the 8.7 release
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

Inbound connector Manage and Run feature documentation
3 participants