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: changing the reset to clear #4822

Merged

Conversation

ana-vinogradova-camunda
Copy link
Contributor

@ana-vinogradova-camunda ana-vinogradova-camunda commented Jan 8, 2025

Description

As there might be multiple task listeners that are triggered in sequence, the word reset might be misleading as it may imply that a previously made correction can be "reset" (i.e. undone).

Solution: using clear instead of reset

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

As there might be multiple task listeners that are triggered in sequence, the word `reset` might be misleading
 as it may imply that a previously made correction can be "reset" (i.e. undone).
Copy link
Contributor

github-actions bot commented Jan 8, 2025

👋 🤖 🤔 Hello, @ana-vinogradova-camunda! 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/zeebe-api/gateway-service.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.

The decision was made to use `clear` as it is used elsewhere in the docs
@ana-vinogradova-camunda ana-vinogradova-camunda marked this pull request as ready for review January 8, 2025 11:04
@ana-vinogradova-camunda ana-vinogradova-camunda changed the title docs: changing the reset to unset docs: changing the reset to clear Jan 8, 2025
@akeller
Copy link
Member

akeller commented Jan 8, 2025

@ana-vinogradova-camunda is this part of the 8.7 minor or alpha3? When can this be merged and released?

@ana-vinogradova-camunda
Copy link
Contributor Author

ana-vinogradova-camunda commented Jan 9, 2025

@ana-vinogradova-camunda is this part of the 8.7 minor or alpha3? When can this be merged and released?

This is a part of alpha3, just a re-wording PR (for more clarity). Can be merged asap.

@ce-dmelnych ce-dmelnych merged commit 2dd8715 into main Jan 9, 2025
10 checks passed
@ce-dmelnych ce-dmelnych deleted the 26345-complete-job-rpc-documentation-clarification branch January 9, 2025 14:43
@akeller akeller added the 8.7.0-alpha3 January 2024 alpha release label Jan 10, 2025
ce-dmelnych added a commit to camunda/camunda that referenced this pull request Jan 13, 2025
Updated the documentation in the `gateway.proto` file to align with the recent changes made to the
gRPC `CompleteJobRequest` API documentation:
- camunda/camunda-docs#4808
- camunda/camunda-docs#4822
ce-dmelnych added a commit to camunda/camunda that referenced this pull request Jan 13, 2025
Updated the documentation in the `gateway.proto` file to align with the recent changes made to the
gRPC `CompleteJobRequest` API documentation:
- camunda/camunda-docs#4808
- camunda/camunda-docs#4822
ce-dmelnych added a commit to camunda/camunda that referenced this pull request Jan 13, 2025
Updated the documentation in the `gateway.proto` file to align with the recent changes made to the
gRPC `CompleteJobRequest` API documentation:
- camunda/camunda-docs#4808
- camunda/camunda-docs#4822
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
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

6 participants