Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Sep 29, 2022

Conversation

freeznet
Copy link
Contributor

@freeznet freeznet commented Jul 31, 2022

Fixes #16674

Motivation

Add doc for #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)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

@freeznet freeznet self-assigned this Jul 31, 2022
@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 Jul 31, 2022
@@ -27,7 +27,9 @@ The configuration of Debezium source connector has the following properties.
| `database.history.pulsar.topic` | true | null | The name of the database history topic where the connector writes and recovers DDL statements. <br /><br />**Note: this topic is for internal use only and should not be used by consumers.** |
| `database.history.pulsar.service.url` | true | null | Pulsar cluster service URL for history topic. |
| `offset.storage.topic` | true | null | Record the last committed offsets that the connector successfully completes. |
| `json-with-envelope` | false | false | Present the message only consist of payload.
| `json-with-envelope` | false | false | Present the message only consist of payload. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `json-with-envelope` | false | false | Present the message only consist of payload. |
| `json-with-envelope` | false | false | Present the message that consists of payload only. |

Is this what it means? The original one has a grammar issue.

Copy link
Contributor

@momo-jun momo-jun left a comment

Choose a reason for hiding this comment

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

@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?

freeznet and others added 2 commits August 2, 2022 05:20
Co-authored-by: momo-jun <60642177+momo-jun@users.noreply.github.com>
Co-authored-by: momo-jun <60642177+momo-jun@users.noreply.github.com>
@codelipenghui codelipenghui added this to the 2.12.0 milestone Aug 8, 2022
@freeznet
Copy link
Contributor Author

freeznet commented Aug 9, 2022

@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?

@momo-jun
Copy link
Contributor

momo-jun commented Aug 9, 2022

@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 added a commit to momo-jun/pulsar that referenced this pull request Aug 9, 2022
@github-actions
Copy link

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

@github-actions github-actions bot added the Stale label Sep 24, 2022
@momo-jun momo-jun merged commit e1e3baf into apache:master Sep 29, 2022
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. Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ability to configure subscription name in debezium connector
4 participants