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: document changes in connectors properties in 8.7+ #5322

Merged
merged 2 commits into from
Mar 28, 2025

Conversation

chillleader
Copy link
Member

@chillleader chillleader commented Mar 20, 2025

Description

I updated the SM connectors doc with more examples of YAML configuration. The 8.8 property names have been changed - e.g. from CAMUNDA_CLIENT_ZEEBE_RESTADDRESS to CAMUNDA_CLIENT_RESTADDRESS - this is intentional.

I also added an announcement and an entry in the update guide for 8.7 due to these potentially breaking changes.

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.

@chillleader chillleader self-assigned this Mar 20, 2025
Copy link
Contributor

github-actions bot commented Mar 20, 2025

👋 🤖 🤔 Hello, @christinaausley! 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/reference/announcements-release-notes/870/870-announcements.md
  • docs/self-managed/connectors-deployment/connectors-configuration.md
  • docs/self-managed/operational-guides/update-guide/860-to-870.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/reference/announcements-release-notes/870/870-announcements.md
  • versioned_docs/version-8.7/self-managed/connectors-deployment/connectors-configuration.md
  • versioned_docs/version-8.7/self-managed/operational-guides/update-guide/860-to-870.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.

@chillleader chillleader added target:8.7 Issues included in the 8.7 release component:connectors Issues related to the connectors project. labels Mar 20, 2025
@chillleader chillleader requested a review from a team March 20, 2025 15:21
@chillleader chillleader marked this pull request as ready for review March 20, 2025 15:22
@chillleader chillleader requested a review from sbuettner March 20, 2025 15:24
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

Thank you for making these changes in both versions! This looks good to me, but feel free to tag me again if it needs an approval after a technical review. 👍

@christinaausley christinaausley self-requested a review March 21, 2025 19:14
@christinaausley
Copy link
Contributor

Assigning myself to review as well as there are a few grammatical tweaks I'd like to make 👍

@chillleader chillleader merged commit a6e3498 into main Mar 28, 2025
8 checks passed
@chillleader chillleader deleted the connectors-properties-docs-improvement branch March 28, 2025 17:21
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. target:8.7 Issues included in the 8.7 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants