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

[docs] CDCSDK: Update CDC documentation with missing sections #21512

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

vaibhav-yb
Copy link
Contributor

@vaibhav-yb vaibhav-yb commented Mar 15, 2024

This PR adds the following sections missing from the CDC documentation:

  1. Connector compatibility matrix - this lists the version of connector which will be compatible with a given YugabyteDB version.
  2. Instructions on troubleshooting failures in case of a table being dropped; this is also valid if a table needs to be dropped.
  3. Multiple before image modes supported by YugabyteDB.

DOC-296

@vaibhav-yb vaibhav-yb added area/documentation Documentation needed area/cdcsdk CDC SDK labels Mar 15, 2024
@vaibhav-yb vaibhav-yb self-assigned this Mar 15, 2024
Copy link

netlify bot commented Mar 15, 2024

Deploy Preview for infallible-bardeen-164bc9 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 8f77640
🔍 Latest deploy log https://app.netlify.com/sites/infallible-bardeen-164bc9/deploys/66462fa0f920bc0008cdf762
😎 Deploy Preview https://deploy-preview-21512--infallible-bardeen-164bc9.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@vaibhav-yb vaibhav-yb changed the title [docs] CDCSDK: Update CDC documentation with missing section [docs] CDCSDK: Update CDC documentation with missing sections Mar 19, 2024
docs/content/preview/admin/yb-admin.md Outdated Show resolved Hide resolved
docs/content/preview/admin/yb-admin.md Outdated Show resolved Hide resolved

{{< note title="Note" >}}

Starting 2.20, the release naming convention has changed and we follow a scheme *major.y.minor* where
Copy link
Contributor

Choose a reason for hiding this comment

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

Starting with YugabyteDB v2.20, the naming convention for releases of the connector uses the scheme major.y.minor, as follows:

  • major - Debezium release the connector is based on
  • minor - version of YugabyteDB the connector works with
    The connector is backward compatible with previous releases of YugabyteDB unless stated otherwise.

Co-authored-by: Dwight Hodge <79169168+ddhodge@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cdcsdk CDC SDK area/documentation Documentation needed
Projects
CDC
  
Awaiting triage
Development

Successfully merging this pull request may close these issues.

None yet

3 participants