Reference Doc Improvements #2867
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| } | ||
| public void send(String toSend, int key) { | ||
| this.template.send("topic1", key, toSend); | ||
| } |
There was a problem hiding this comment.
seems we use 4 spaces in lieu of TAB in code snippets in reference. The above code uses TAB instead, ending up with ugly inconsitent indentation in the same code example:
| @@ -15,7 +15,7 @@ To close existing Consumers, call `stop()` (and then `start()`) on the `KafkaLis | |||
| For convenience, the framework also provides an `ABSwitchCluster` which supports two sets of bootstrap servers; one of which is active at any time. | |||
| Configure the `ABSwitchCluster` and add it to the producer and consumer factories, and the `KafkaAdmin`, by calling `setBootstrapServersSupplier()`. | |||
| When you want to switch, call `primary()` or `secondary()` and call `reset()` on the producer factory to establish new connection(s); for consumers, `stop()` and `start()` all listener containers. | |||
| When using `@KafkaListener` s, `stop()` and `start()` the `KafkaListenerEndpointRegistry` bean. | |||
| When using `@KafkaListener`+++s+++, `stop()` and `start()` the `KafkaListenerEndpointRegistry` bean. | |||
There was a problem hiding this comment.
in AsciiDoc, `s will be rendered as
that was why a space was inserted to avoid it. however, it looks weird:
using +++ solves the issue:
| * `ProducerFactory` - see xref:kafka/sending-messages.adoc[Sending Messages] | ||
| * `ConsumerFactory` - see xref:kafka/receiving-messages.adoc[Receiving Messages] | ||
|
|
||
| Starting with version 2.5, each of these extends `KafkaResourceFactory`. | ||
| This allows changing the bootstrap servers at runtime by adding a `Supplier<String>` to their configuration: `setBootstrapServersSupplier(() -> ...)`. | ||
| This allows changing the bootstrap servers at runtime by adding a `Supplier<String>` to their configuration: `setBootstrapServersSupplier(() +++->+++ ...)`. |
There was a problem hiding this comment.
-> is special char in AsciiDoc, so we could use +++ to render it literally
| .assignReplicas(2, Arrays.asList(2, 0)) | ||
| .assignReplicas(0, List.of(0, 1)) | ||
| .assignReplicas(1, List.of(1, 2)) | ||
| .assignReplicas(2, List.of(2, 0)) |
There was a problem hiding this comment.
not necessary, but we have used Java 17, why not use the handy collection constant feature introduced since Java 9?
NathanQingyangXu
force-pushed
the
feature/some-minor-improvement-reference
branch
from
4002fae
to
0f60347
Compare
NathanQingyangXu
force-pushed
the
feature/some-minor-improvement-reference
branch
from
0f60347
to
59b0324
Compare
|
Thanks!! |
garyrussell
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
some minor improvements to reference. See self-comments for the rationale behind the changes. Potentially more similar PRs will come in later