Skip to content

Clarification in DLQ documentation#5029

Merged
codelipenghui merged 1 commit intoapache:masterfrom
cdbartholomew:patch-2
Aug 26, 2019
Merged

Clarification in DLQ documentation#5029
codelipenghui merged 1 commit intoapache:masterfrom
cdbartholomew:patch-2

Conversation

@cdbartholomew
Copy link
Contributor

The first question I had when I read this section is what is the name of the DLQ topic. I found the answer in the Java API docs, but I think it makes sense to include it in this section, especially since this feature now also works in the Websocket client. I added the name of the default dead letter queue and an example of how to specify the DLQ name.

(If this PR fixes a github issue, please add Fixes #<xyz>.)

Fixes #

(or if this PR is one task of a github issue, please add Master Issue: #<xyz> to link to the master issue.)

Master Issue: #

Motivation

Explain here the context, and why you're making that change. What is the problem you're trying to solve.

Modifications

Describe the modifications you've done.

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

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
  • If a feature is not applicable for documentation, explain why?
  • If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

The first question I had when I read this section is what is the name of the DLQ topic. I found the answer in the Java API docs, but I think it makes sense to include it in this section, especially since this feature now also works in the Websocket client. I added the name of the default dead letter queue and an example of how to specify the DLQ name.
@sijie sijie added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. component/website labels Aug 23, 2019
@sijie sijie added this to the 2.5.0 milestone Aug 23, 2019
@sijie
Copy link
Member

sijie commented Aug 25, 2019

run cpp tests

@codelipenghui codelipenghui merged commit ff41871 into apache:master Aug 26, 2019
@cdbartholomew cdbartholomew deleted the patch-2 branch August 27, 2019 13:58
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