docs(db-extractors): audit & fix DB data-source connector docs against source code#970
Closed
Iamfle4ka wants to merge 1 commit into
Closed
docs(db-extractors): audit & fix DB data-source connector docs against source code#970Iamfle4ka wants to merge 1 commit into
Iamfle4ka wants to merge 1 commit into
Conversation
…rors
Audited the 12 database data-source connector pages against the connector
source code. Fixes:
- correct query-based component IDs for Oracle (keboola.ex-db-oracle) and
PostgreSQL (keboola.ex-db-pgsql)
- fix broken in-page anchors (#initial-setup, #mysql-log-based-cdc,
#postgresql-log-based-cdc)
- correct PostgreSQL page copy-paste errors (MySQL->PostgreSQL connection
settings, datatype mapping intro, binlog->WAL)
- point MySQL column-mask links to Debezium mysql connector docs
- repair malformed/AsciiDoc-leftover links and {prodname} placeholders
- fix wrong Azure Storage Table link on overview page
- convert absolute help.keboola.com links to internal relative links
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Closing per change of plan: this is an audit-only task. No documentation edits to be merged. Findings will be posted to the Linear issue/document. Branch kept for reference. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira issue(s): PROOF-XXX
Audited all 12 pages under
src/content/docs/components/extractors/database/against the authoritative connector source code:keboola/db-extractor-{mysql,pgsql,oracle,mssql}(component IDs verified from each repo's deploy config).keboola/python-cdc-component(db_components/ex_mysql_cdc,ex_postgres_cdc).keboola/ex-cosmosdb,keboola/ex-azure-storage-table,keboola/ex-mongodb,keboola/component-filemaker,keboola/ex-google-bigquery-v2.Scope was accuracy fixes only — no restructuring or writing-style changes; frontmatter and screenshots preserved.
npm run buildpasses (254 pages, no errors).node scripts/audit-phase2.mjsreports no new findings for these pages.Changes:
oracle/index.md— Wrong component URL: query-based connector linked tokeboola.ex-db-mysql; corrected tokeboola.ex-db-oracle(verified inkeboola/db-extractor-oracle). Fixed broken anchorsqldb/#create-new-configuration→sqldb/#initial-setup.postgresql/index.md— Wrong component URLkeboola.ex-db-mysql→keboola.ex-db-pgsql. Connection Settings described "the MySQL server" (copy-paste from the MySQL CDC component) → "the PostgreSQL server". Data-type intro "MySQL datatypes" → "PostgreSQL datatypes". Replication Mode said the connector "reads the binlog" → "reads the transaction log (WAL)" (Postgres has no binlog). Fixed malformed SSH-tunnel link (missing closing)), AsciiDoc migration leftovers (link:prefixes,link:URL[text]form,{prodname}→Debezium, strayendif::community[]), broken anchors (#create-new-configuration→#initial-setup,#log-based-cdc→#postgresql-log-based-cdc), and a Replication Plugin Advanced Options screenshot pointing atimg_4.png(heartbeat image) →img_2.png(alt text already saidimg_2.png).mysql/index.md— Column-mask docs linked to the Debezium postgresql connector page; corrected to the mysql connector page (mysql.html#mysql-property-column-mask-*). Fixed broken anchors#create-new-configuration→#initial-setupandmysql#log-based-binlog-cdc→mysql/#mysql-log-based-cdc. Converted absolutehelp.keboola.comdata-types link to internal relative link.ms-sql/index.md— Fixed broken anchor#create-new-configuration→#initial-setupand a malformed inline-code link[`cdc_get_net_changes](missing closing backtick).index.md(overview) — "Azure Storage Table connector" linked to/cosmosdb/; corrected to/azure-storage-table/. Fixed broken anchor#create-new-configuration→#initial-setup.azure-storage-table/index.md— Converted absolutehelp.keboola.comlinks to internal relative links.Verified accurate (no changes needed):
cosmosdb,azure-storage-table(params),filemaker,bigquery,mongodb,mongodb/mapping,sqldbconfig fields all match current config schemas / READMEs.Flagged for a human (product decisions, not doc bugs)
mysql/index.mdlists MySQL 5.7, 8.0.x, 8.2, but the component README (python-cdc-component/db_components/ex_mysql_cdc/README.md) lists only 8.0.x, 8.2 (driver 8.3.0). Confirm whether 5.7 is still supported before removing/keeping it.mongodb/index.mdsays "from 4.4 to the latest (6.0)", but the component now bundlesmongodb-database-tools 100.15.0(ex-mongodb/Dockerfile), which supports newer MongoDB (7.0/8.0). The "(6.0)" parenthetical is likely stale; please confirm the intended supported range.ex_postgres_cdc/README.mditself contains the same "MySQL server" connection-settings text and "binlog" wording (lines ~409, 451–452). Recommend fixing upstream so the docs and component stay in sync.mongodb/index.mdandmongodb/mapping.mdstill use raw<table class="table table-bordered">markup. Left as-is (out of accuracy scope / would be a restructure); flagging for a future cleanup pass.Note on the pre-audit hints: the "5 pages with
.html-style internal links" did not materialize — all.htmllinks in these pages are legitimate external URLs (debezium.io, microsoft.com, postgresql.org, etc.). The actual migration leftovers found were AsciiDoc artifacts inpostgresql/index.md(fixed above).Link to Devin session: https://app.devin.ai/sessions/fe9e6287d36141e6986c15a5c67f53d2
Requested by: @Iamfle4ka