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 8.8 Announcements #4888

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

Add 8.8 Announcements #4888

wants to merge 4 commits into from

Conversation

akeller
Copy link
Member

@akeller akeller commented Jan 22, 2025

Description

Adds 8.8 announcements page. Copies 8.7 announcements and removes items shipped in 8.7 (as identified here in the docs section).

‼️ This PR cannot be merged until 8.8 docs are available in /next/!!! ‼️

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 the next minor and are in /docs directory (aka /next/).
  • My changes are for an already released minor and are in /versioned_docs directory.

@akeller akeller added hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR target:8.8 Issues included in the 8.8 release labels Jan 22, 2025
@akeller akeller self-assigned this Jan 22, 2025
Copy link
Contributor

👋 🤖 🤔 Hello, @akeller! 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.md
  • docs/reference/announcements/880.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 January 22, 2025 15:55 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs January 22, 2025 20:47 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs January 23, 2025 13:01 Destroyed
Copy link
Contributor

@aleksander-dytko aleksander-dytko left a comment

Choose a reason for hiding this comment

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

@akeller reviewed the announcement page, specifically focusing on the API scope.

sidebars.js Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements/880.md Outdated Show resolved Hide resolved
docs/reference/announcements/880.md Outdated Show resolved Hide resolved
docs/reference/announcements/880.md Outdated Show resolved Hide resolved
docs/reference/announcements/880.md Outdated Show resolved Hide resolved
docs/reference/announcements/880.md Outdated Show resolved Hide resolved
docs/reference/announcements/880.md Outdated Show resolved Hide resolved

:::note

- If you need to continue using the old `ZeebeClient`, you can use the version 8.6 artifact without any issues with newer cluster versions as the client is forward-compatible.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- If you need to continue using the old `ZeebeClient`, you can use the version 8.6 artifact without any issues with newer cluster versions as the client is forward-compatible.
- If you need to continue using the old `ZeebeClient`, you can use the version 8.7 artifact without any issues with newer cluster versions as the client is forward-compatible.

Copy link
Contributor

Choose a reason for hiding this comment

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

@tmetzke, is that something that we can guarantee?

Copy link
Member Author

Choose a reason for hiding this comment

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

@aleksander-dytko I committed all your suggestions, but left this one for @tmetzke to chime in on.

Copy link
Member Author

Choose a reason for hiding this comment

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

@tmetzke can you confirm this is correct for 8.8?

If you need to continue using the old ZeebeClient, you can use the version 8.7 artifact without any issues with newer cluster versions as the client is forward-compatible.

docs/reference/announcements/880.md Outdated Show resolved Hide resolved
Co-authored-by: Aleksander Dytko <[email protected]>
New migration guides will also be provided to support you when migrating from a previous Camunda version.

:::caution
Additional upgrade considerations are necessary for deployments that use custom scripts, such as Docker containers, manual installations, or custom-developed Kubernetes deployments. For these deployments, customers can either continue to deploy with their original 8.7 topology and upgrade each component independently, or adopt our Helm Chart approach for the upgrade, which allows for unifying the deployment into a single JAR or container executable.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

The exporter can consume Zeebe records (mostly events created by the engine), aggregate data, and store the related data into shared and harmonized indices.

- Data is archived in the background, coupled to the exporter but without blocking the exporter's progress.
- Indices can be located in either ElasticSearch (ES) or Opensearch (OS). Our web components (Tasklist and Operate) then use the new harmonized indices to show data to the user.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

The exporter can consume Zeebe records (mostly events created by the engine), aggregate data, and store the related data into shared and harmonized indices.

- Data is archived in the background, coupled to the exporter but without blocking the exporter's progress.
- Indices can be located in either ElasticSearch (ES) or Opensearch (OS). Our web components (Tasklist and Operate) then use the new harmonized indices to show data to the user.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

@github-actions github-actions bot temporarily deployed to camunda-docs February 5, 2025 15:24 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs February 7, 2025 16:42 Destroyed
Copy link
Contributor

github-actions bot commented Feb 7, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8.0-alpha1 deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. target:8.8 Issues included in the 8.8 release
Projects
Status: 🏗 In Progress
Development

Successfully merging this pull request may close these issues.

4 participants