-
Couldn't load subscription status.
- Fork 12
auto-docs: Update RPCN connector docs #317
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
Conversation
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthrough
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (5)
docs-data/connect-diff-4.66.1_to_4.66.1.json (1)
3-6: Self-diff (4.66.1 → 4.66.1) looks intentional; confirm retention policy.If no changes are present, consider skipping committing identical diffs to reduce churn, unless required for auditability.
modules/get-started/pages/whats-new.adoc (1)
11-17: Section structure LGTM; clarify empty “Component updates”.Either list updates or add a short “No component updates in this release.” line to avoid an empty section.
modules/components/partials/drafts/microsoft_sql_server_cdc.adoc (3)
70-72: Tighten wording (remove redundant “too”).Keep it concise.
-Additionally, if `stream_snapshot` is set to true, then the existing data in the database is also streamed too. +Additionally, if `stream_snapshot` is set to true, the existing data in the database is also streamed.
18-41: Common and Advanced tabs are identical.Either deduplicate to a single tab for now or expand “Advanced” with advanced-only fields when available (timeouts, TLS, jitter, etc.).
Also applies to: 43-66
80-81: Whitespace nit.Remove the stray whitespace after the lsn bullet to avoid formatter noise.
-- lsn (the Log Sequence Number in Microsoft SQL Server) - +- lsn (the Log Sequence Number in Microsoft SQL Server)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
docs-data/connect-diff-4.66.1_to_4.66.1.json(1 hunks)modules/components/partials/drafts/microsoft_sql_server_cdc.adoc(3 hunks)modules/get-started/pages/whats-new.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-connect
- GitHub Check: Header rules - redpanda-connect
- GitHub Check: Pages changed - redpanda-connect
🔇 Additional comments (1)
modules/components/partials/drafts/microsoft_sql_server_cdc.adoc (1)
13-14: Update “Introduced in version” to a real release or placeholder.Replace:
-Introduced in version 0.0.1. +Introduced in version <VERSION>.Confirm and fill in the actual version when known.
modules/components/partials/drafts/microsoft_sql_server_cdc.adoc
Outdated
Show resolved
Hide resolved
060b9d2 to
8339c10
Compare
8339c10 to
33ce3bd
Compare
| [WARNING] | ||
| .Deprecated | ||
| ==== | ||
| This component is deprecated and will be removed in the next major version release. Please consider moving onto the unified xref:components:inputs/redpanda_migrator.adoc[`redpanda_migrator` input] and xref:components:outputs/redpanda_migrator.adoc[`redpanda_migrator` output] components. For migration instructions, see xref:guides:migration/migrate-unified-redpanda-migrator.adoc[]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we include the info on when this component was deprecated?
| == Metadata | ||
| This input adds the following metadata fields to each message: | ||
|
|
||
| ```text |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no more codeblock?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
|
||
| This input adds the following metadata fields to each message: | ||
|
|
||
| ```text |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this one still has it?
modules/components/pages/outputs/legacy_redpanda_migrator_offsets.adoc
Outdated
Show resolved
Hide resolved
7cad7e6 to
575ce12
Compare
3bc8a96 to
d582a18
Compare
82b0e00 to
fa99491
Compare
fa99491 to
d804d22
Compare
d804d22 to
fa99491
Compare
RPCN Connector Generation Output
✅ Fetched and saved: /home/runner/work/rp-connect-docs/rp-connect-docs/docs-data/connect-4.67.5.json
⏳ Generating connector partials...
⏳ Drafting missing connectors…
No GitHub token found (VBOT_GITHUB_API_TOKEN).
Saved: /tmp/redpanda-connect-csv/info.csv
📥 Loaded CSV from GitHub into: /tmp/redpanda-connect-csv/info.csv
✅ Parsed 310 connector records.
⏳ Docs missing for 8 connectors:
• processor/a2a_message
• processor/jira
• input/legacy_redpanda_migrator
• output/legacy_redpanda_migrator
• input/legacy_redpanda_migrator_offsets
• output/legacy_redpanda_migrator_offsets
• input/microsoft_sql_server_cdc
• input/pg_stream
Skipping draft for deprecated component: inputs/legacy_redpanda_migrator
Skipping draft for deprecated component: inputs/legacy_redpanda_migrator_offsets
Skipping draft for deprecated component: inputs/pg_stream
Skipping draft for deprecated component: outputs/legacy_redpanda_migrator
Skipping draft for deprecated component: outputs/legacy_redpanda_migrator_offsets
📋 RPCN Connector Delta Report
➤ Newly added components:
• inputs/legacy_redpanda_migrator (deprecated) — introduced in 4.37.0
• inputs/legacy_redpanda_migrator_offsets (deprecated) — introduced in 4.45.0
• outputs/legacy_redpanda_migrator (deprecated) — introduced in 4.37.0
• outputs/legacy_redpanda_migrator_offsets (deprecated) — introduced in 4.37.0
➤ Newly added fields:
• inputs:microsoft_sql_server_cdc → checkpoint_cache_table_name
• inputs:microsoft_sql_server_cdc → checkpoint_cache_key
• inputs:redpanda_migrator → schema_registry
• outputs:redpanda_migrator → schema_registry
• outputs:redpanda_migrator → consumer_groups
• outputs:redpanda_migrator → topic_replication_factor
• outputs:redpanda_migrator → sync_topic_acls
• outputs:redpanda_migrator → serverless
✅ Connector diff JSON written to: /home/runner/work/rp-connect-docs/rp-connect-docs/docs-data/connect-diff-4.66.1_to_4.67.5.json
✅ Updated Antora version: 4.67.5
📊 Generation Report:
• Partial files: 874
• Fields partials: 265 total
– modules/components/partials/fields/buffers/memory.adoc
– modules/components/partials/fields/buffers/sqlite.adoc
– modules/components/partials/fields/buffers/system_window.adoc
– modules/components/partials/fields/caches/aws_dynamodb.adoc
– modules/components/partials/fields/caches/aws_s3.adoc
– modules/components/partials/fields/caches/couchbase.adoc
– modules/components/partials/fields/caches/file.adoc
– modules/components/partials/fields/caches/gcp_cloud_storage.adoc
– modules/components/partials/fields/caches/lru.adoc
– modules/components/partials/fields/caches/memcached.adoc
… plus 255 more
• Examples partials: 609 total
– modules/components/partials/examples/buffers/sqlite.adoc
– modules/components/partials/examples/buffers/system_window.adoc
– modules/components/partials/examples/caches/multilevel.adoc
– modules/components/partials/examples/inputs/azure_cosmosdb.adoc
– modules/components/partials/examples/inputs/cassandra.adoc
– modules/components/partials/examples/inputs/file.adoc
– modules/components/partials/examples/inputs/gcp_bigquery_select.adoc
– modules/components/partials/examples/inputs/generate.adoc
– modules/components/partials/examples/inputs/http_client.adoc
– modules/components/partials/examples/inputs/http_server.adoc
… plus 599 more
• Full drafts: 1
• Draft files: 1 total
– modules/components/partials/drafts/microsoft_sql_server_cdc.adoc
✅ whats-new.adoc updated with Version 4.67.5
📄 Summary:
• Run time: 2025-10-24T10:08:22.294Z
• Version used: 4.67.5
For help reviewing this content, see our wiki.