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: remove alpha feature nature from C8 Query API #4762

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tmetzke
Copy link
Member

@tmetzke tmetzke commented Dec 12, 2024

Description

Remove the alpha documentation from the C8 REST Query API.

closes #4761

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

@tmetzke tmetzke added theme:api-streamline Issues related to the theme of streamlining APIs 8.7.0-alpha3 January 2024 alpha release labels Dec 12, 2024
@tmetzke tmetzke requested review from a team December 12, 2024 16:04
@tmetzke tmetzke self-assigned this Dec 12, 2024
Copy link
Contributor

👋 🤖 🤔 Hello, @tmetzke! 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/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
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.

  1. In terms of sequencing, we should probably wait to merge this PR until Remove alpha label from query API in OpenAPI spec camunda#26022 is complete and the API spec has been updated here in the docs.
  2. @tmetzke I interpret this PR to mean that we do not intend to have alpha features in the API in the future. Is that accurate? If it's not, and it's more a case of we've graduated all current alpha endpoints, then I think we should leave this explanation in the docs for when another alpha endpoint comes.
  3. If we are indeed done with alpha endpoints, then there is also some logic I can remove in the API generation process (which docusaurus-ifies the alpha notes in the spec). I will take care of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha3 January 2024 alpha release theme:api-streamline Issues related to the theme of streamlining APIs
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

Mark C8 REST Query API as stable
3 participants