cloud: Add Pulsar support docs #21027
Conversation
Signed-off-by: Ben Meadowcroft <[email protected]>
ti-chi-bot
bot
added
contribution
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @benmeadowcroft, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello! Gemini here, providing a summary of this pull request to help everyone get up to speed. This PR introduces documentation for the new feature in TiDB Cloud Dedicated that allows users to configure a changefeed to stream data to Apache Pulsar. The changes include adding a link to the new document in the table of contents and adding the comprehensive guide on setting up the Pulsar sink, covering prerequisites, connection methods, authentication, advanced settings, filtering (tables and events), replication start position, data format (Canal-JSON), topic distribution, and partition distribution.
Highlights
- New Documentation: Adds a complete guide (
tidb-cloud/changefeed-sink-to-apache-pulsar.md) explaining how to configure a TiDB Cloud changefeed to replicate data to Apache Pulsar. - Table of Contents Update: Updates the TiDB Cloud table of contents (
TOC-tidb-cloud.md) to include a link to the new Pulsar sink documentation. - Detailed Configuration Steps: The new document provides detailed steps for setting up the Pulsar sink, including network configuration (VPC Peering, Public IP), authentication, advanced settings (compression, batching, timeouts), data filtering, start position, data format (Canal-JSON), and strategies for distributing messages across Pulsar topics and partitions.
Changelog
- TOC-tidb-cloud.md
- Added a new entry '- To Pulsar Sink' under the 'Changefeed' section to link the new documentation.
- tidb-cloud/changefeed-sink-to-apache-pulsar.md
- Added a new markdown file containing the documentation for configuring a TiDB Cloud changefeed to sink data to Apache Pulsar.
- Includes sections on restrictions, prerequisites (network, permissions, topic creation), and step-by-step instructions for configuring the destination, replication settings (filters, start position, data format, topic/partition distribution), and reviewing the specification.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for using Apache Pulsar as a sink for TiDB Cloud changefeeds. The new document tidb-cloud/changefeed-sink-to-apache-pulsar.md is well-structured and detailed, covering restrictions, prerequisites, and a step-by-step guide for configuration. The update to the Table of Contents is also correct.
I've included several suggestions below, mostly focused on enhancing clarity, conciseness, and adherence to the style guide (e.g., active voice, present tense, and precise wording). These are primarily minor improvements to ensure the documentation is as user-friendly as possible.
Overall, great work on documenting this new feature!
Summary of Findings
- Typos and Minor Wording: Several minor typos (e.g., "automically", "Destinaton", "intende", "is send") and opportunities for clearer or more concise wording were identified throughout the document.
- Style Guide Adherence (Passive Voice and Tense): Multiple instances of passive voice and future tense were found. The style guide recommends active voice and present tense for better readability and directness. Suggestions have been provided to address these.
- Clarity of Instructions: Some instructions, particularly regarding user actions (e.g., creating Pulsar topics in advance), could be strengthened by using more direct language (e.g., "You must...").
- Markdown Formatting: A minor markdown formatting issue (extra blank line) was noted.
Merge Readiness
The documentation for Apache Pulsar sink is comprehensive and well-written. The suggested changes are mostly minor and aim to enhance clarity and adherence to the style guide. After addressing these points, the document will be in excellent shape. As per the style guide, I am providing comments rather than requesting changes to avoid blocking the merge. I am not authorized to approve pull requests; please ensure other reviewers approve this before merging.
Oreoxmt
added
translation/no-need
ti-chi-bot
bot
removed
the
missing-translation-status
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
Address review feedback
|
/approve |
ti-chi-bot
bot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Ben Meadowcroft [email protected]
What is changed, added or deleted? (Required)
TiDB Cloud Dedicated is adding support for Apache Pulsar as a downstream target for streaing data using a TiCDC changefeed. This PR includes documentation of that new feature.
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?