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

docs: move from experimental Query API to alpha #4293

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

tmetzke
Copy link
Member

@tmetzke tmetzke commented Sep 12, 2024

Description

Documents experimental C8 REST Query API as alpha feature, not experimental. Alpha features are clearly defined in the reference documentation and contracts in contrast to experimental features.

related to camunda/camunda#22224

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/).

Documents experimental C8 REST Query API as alpha feature, not experimental.
Alpha features are clearly defined in the reference documentation and contracts
in contrast to experimental features.
@tmetzke tmetzke added component:zeebe Issues related with Zeebe project target:8.6 Issues included in the 8.6 release labels Sep 12, 2024
@tmetzke tmetzke requested review from pepopowitz and a team September 12, 2024 14:38
@tmetzke tmetzke self-assigned this Sep 12, 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/apis-tools/camunda-api-rest/camunda-api-rest-overview.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'm not sure you even need the trailing empty brackets [] when using reference-style links, but it seems to still work fine, so this looks good to me! 👍

Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

🙌 Looks good to me!

@tmetzke tmetzke merged commit a544292 into main Sep 13, 2024
11 of 12 checks passed
@tmetzke tmetzke deleted the 22224-c8-rest-query-alpha branch September 13, 2024 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:zeebe Issues related with Zeebe project target:8.6 Issues included in the 8.6 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants