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

add hybrid mode to glossary #4201

Merged
merged 3 commits into from
Aug 28, 2024
Merged

add hybrid mode to glossary #4201

merged 3 commits into from
Aug 28, 2024

Conversation

christinaausley
Copy link
Contributor

Description

Closes https://github.com/camunda/developer-experience/issues/323 -- adds hybrid mode to glossary.

When should this change go live?

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

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added component:docs Documentation improvements, including new or updated content component:connectors Issues related to the connectors project. labels Aug 27, 2024
@christinaausley christinaausley requested review from akeller and a team August 27, 2024 18:38
@christinaausley christinaausley self-assigned this Aug 27, 2024
Copy link
Contributor

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

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.

I know this definition mostly comes from the linked hybrid mode page, but I think both could be simplified for clarity, as an example:

Hybrid mode, or a hybrid Self-Managed distribution, allows you to run an separate instance of the Connectors runtime in a self-managed or local fashion. This instance can be attached to either a SaaS cluster, or another Self-Managed cluster with its own Connectors runtime, to apply changes or isolate the instance from the public internet.

This has the added benefit of giving a useful definition to the times in the Connectors pages we use "Hybrid/Self Managed" as a description.

Somewhat separately, is this release number useful here (and on the linked hybrid mode page), or does it also need additional context? I am not sure if it's easy for someone to know what connectors release they're on, or what version of Camunda 8 that might apply to.

@christinaausley
Copy link
Contributor Author

@conceptualshark I've applied a few of your suggested changes, and agreed, removed the release number from the glossary description within the scope of this issue 👍

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.

Looks clean to me!

@christinaausley christinaausley merged commit 9051b5e into main Aug 28, 2024
7 checks passed
@christinaausley christinaausley deleted the link-to-hybrid-mode branch August 28, 2024 14:58
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:docs Documentation improvements, including new or updated content
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants