Skip to content
This repository was archived by the owner on Jan 24, 2024. It is now read-only.

Update docs for multiple listeners and non-partitioned topic support - #760

Merged
BewareMyPower merged 5 commits into
streamnative:masterfrom
BewareMyPower:bewaremypower/doc-update
Sep 30, 2021
Merged

Update docs for multiple listeners and non-partitioned topic support#760
BewareMyPower merged 5 commits into
streamnative:masterfrom
BewareMyPower:bewaremypower/doc-update

Conversation

@BewareMyPower

Copy link
Copy Markdown
Contributor

Motivation

#690 supports non-partitioned topics and #742 supports multiple listeners and marks some configs as deprecated, so the current documents are outdated.

Modification

Even if KoP supports non-partitioned topics now, it's still better to configure allowAutoTopicCreationType with partitioned by default. This PR modified the explanation for the reason.

This PR also adds docs for how to enable multiple listeners and updates the related configuration docs.

In addition, #742 marks kafkaListenerName as deprecated, but it also makes this config not work anymore. So this PR removes the config and related tests.

@BewareMyPower BewareMyPower self-assigned this Sep 28, 2021
@BewareMyPower BewareMyPower added the doc This pr contains a document label Sep 28, 2021
@BewareMyPower

Copy link
Copy Markdown
Contributor Author

@Anonymitaet Please take a look at the doc part. If you have any question, please ping me.

Comment thread docs/configuration.md Outdated
Comment thread docs/configuration.md Outdated

@Anonymitaet Anonymitaet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@BewareMyPower Overall looks good, just leave some minor edits, PTAL.

@jennifer88huang since you are the owner of StreamNative Platform, could you help review? Thanks

@BewareMyPower

Copy link
Copy Markdown
Contributor Author

@Anonymitaet comments are addressed, PTAL again.

@Jennifer88huang-zz Jennifer88huang-zz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@BewareMyPower Good job~
I've made some minor edits, you can merge this PR after refining those comments. Any issue, feel free to ping me. Thank you.

Comment thread docs/configuration.md Outdated
Comment thread docs/configuration.md Outdated
Comment thread docs/configuration.md Outdated
@BewareMyPower

Copy link
Copy Markdown
Contributor Author

I've addressed the comments, PTAL @jennifer88huang

@BewareMyPower
BewareMyPower merged commit 2b90faa into streamnative:master Sep 30, 2021
@BewareMyPower
BewareMyPower deleted the bewaremypower/doc-update branch September 30, 2021 09:26
BewareMyPower added a commit that referenced this pull request Sep 30, 2021
…760)

### Motivation

#690 supports non-partitioned topics and #742 supports multiple listeners and marks some configs as deprecated, so the current documents are outdated. 

### Modification
Even if KoP supports non-partitioned topics now, it's still better to configure `allowAutoTopicCreationType` with `partitioned` by default. This PR modified the explanation for the reason.

This PR also adds docs for how to enable multiple listeners and updates the related configuration docs.

In addition, #742 marks `kafkaListenerName` as deprecated, but it also makes this config not work anymore. So this PR removes the config and related tests.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

doc This pr contains a document

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants