Skip to content

Conversation

@liangyepianzhou
Copy link
Contributor

@liangyepianzhou liangyepianzhou commented May 9, 2022

Motivation

Now, the website do not have related doc of CommandAckResponse in #8996.

Modification

Add the doc for CommandAckResponse.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end deployment with large payloads (10MB)
  • Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API: (yes / no)
  • The schema: (yes / no / don't know)
  • The default values of configurations: (yes / no)
  • The wire protocol: (yes / no)
  • The rest endpoints: (yes / no)
  • The admin cli options: (yes / no)
  • Anything that affects deployment: (yes / no / don't know)

Documentation

Check the box below or label this PR directly.

Need to update docs?

  • doc-required
    (Your PR needs to update docs and you will update later)

  • no-need-doc
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-added
    (Docs have been already added)

### Motivation
Now, the website do not have related doc of `CommandAckResponse`.
### Modification
Add the doc for `CommandAckResponse`.
@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label May 9, 2022
@RobertIndie RobertIndie added this to the 2.11.0 milestone May 9, 2022
Co-authored-by: Zike Yang <zike@apache.org>
@momo-jun
Copy link
Contributor

momo-jun commented May 9, 2022

Two more suggestions:

@liangyepianzhou liangyepianzhou changed the title [Doc] Add doc for CommandAckResponse [feature][Doc] Add doc for CommandAckResponse May 9, 2022
@liangyepianzhou
Copy link
Contributor Author

Two more suggestions:

In fact, the ACK Response has existed for a long time, and this PR just adds a request ID. This is also the reason why I didn't add this PR link before.

@momo-jun
Copy link
Contributor

momo-jun commented May 9, 2022

Does this doc change apply to version 2.8 or later? If yes, more historical versions of docs need update (site2/website/versioned_docs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants