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: recommend the sync workflow for changes to C8 REST API vNext #5113

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

Conversation

pepopowitz
Copy link
Collaborator

Description

Related to camunda/camunda#28943.

Updates the API Explorer guidance to recommend using the synchronization workflow to update docs when possible.

Inspired by conversation in this PR.

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.

@pepopowitz pepopowitz added low prio There is no urgency with this change. component:api Issues related to the C8 REST API labels Feb 27, 2025
@pepopowitz pepopowitz self-assigned this Feb 27, 2025
Copy link
Member

@tmetzke tmetzke left a comment

Choose a reason for hiding this comment

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

👍 Great improvement and clarification

github-merge-queue bot pushed a commit to camunda/camunda that referenced this pull request Feb 28, 2025
## Description

Updates the REST API guidance to recommend using the synchronization
workflow to update docs when possible.

Inspired by [conversation in this
PR](camunda/camunda-docs#5095).

Related PR: camunda/camunda-docs#5113
Copy link
Member

@maff maff left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of updating the guide, it's now very clear what needs (not) to be done when updating the API 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:api Issues related to the C8 REST API low prio There is no urgency with this change.
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

3 participants