pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

[improve][doc] Add doc of reader config to `pulsar-io-debezium`

Open freeznet opened this issue 2 years ago • 2 comments

Fixes https://github.com/apache/pulsar/issues/16674

Motivation

Add doc for https://github.com/apache/pulsar/pull/16675

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

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)

  • [ ] doc-not-needed (Please explain why)

  • [x] doc (Your PR contains doc changes)

  • [ ] doc-complete (Docs have been already added)

freeznet avatar Jul 31 '22 09:07 freeznet

@freeznet thanks for adding the docs. I left several minor suggestions. Another concern is the historical doc versions you changed is 2.9.3 and 2.10.1 while the code PR seems to serve 2.9.4 and 2.10.2?

@momo-jun you are right, could you please tell me how can I add the doc to 2.9.4 and 2.10.2?

freeznet avatar Aug 09 '22 01:08 freeznet

@freeznet thanks for adding the docs. I left several minor suggestions. Another concern is the historical doc versions you changed is 2.9.3 and 2.10.1 while the code PR seems to serve 2.9.4 and 2.10.2?

@momo-jun you are right, could you please tell me how can I add the doc to 2.9.4 and 2.10.2?

In the current practice of Pulsar doc release and maintenance, the docs for the upcoming 2.9.4 and 2.10.2 releases aren't in place until the release is ready to announce. Since PIP-190 has been adopted, I'm generating 2.9.x and 2.10.x docs in #17074. You can leave them as they are in this PR and I will sync your changes there.

momo-jun avatar Aug 09 '22 02:08 momo-jun

The pr had no activity for 30 days, mark with Stale label.

github-actions[bot] avatar Sep 24 '22 02:09 github-actions[bot]