Skip to content

PRDCT-342: land the June DB-connector audit fixes that were never applied - #1080

Draft
Iamfle4ka wants to merge 2 commits into
mainfrom
PRDCT-342-db-connector-fixes
Draft

PRDCT-342: land the June DB-connector audit fixes that were never applied#1080
Iamfle4ka wants to merge 2 commits into
mainfrom
PRDCT-342-db-connector-fixes

Conversation

@Iamfle4ka

@Iamfle4ka Iamfle4ka commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

The June audit found all of this and opened #970 — which was then closed on purpose: "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."

The second half of that plan never ran. So every finding below has been live on help.keboola.com for seven weeks. This recovers the kept branch (devin/1781787795-db-extractor-docs-audit) and re-verifies each change against current main — nothing is taken on faith from the June diff.

Wrong component, wrong database

Page Was Now
Oracle links keboola.ex-db-mysql as "this connector" keboola.ex-db-oracle
PostgreSQL links keboola.ex-db-mysql keboola.ex-db-pgsql

Both IDs confirmed to exist via the public Storage API component index, not just by eye.

Also on the PostgreSQL page:

  • The credentials list described "the MySQL server" in all four fields — Host, Port, User, Password.
  • The CDC section said the connector reads "the binlog". That is MySQL's mechanism; PostgreSQL uses the write-ahead log — which the same page explains correctly a few sections earlier.
  • The data-type table was titled "MySQL datatypes are mapped to…".

And on the MySQL page: the column-mask notes linked Debezium's PostgreSQL connector docs. Now the MySQL page — both #mysql-property-column-mask-* anchors verified live.

Broken anchors

/components/extractors/database/sqldb/#create-new-configuration does not exist; the heading is Initial Setup. It was linked from five pages (index, ms-sql, mysql, oracle, postgresql). Also fixed the page-local #log-based-cdc#postgresql-log-based-cdc.

Wrong screenshot

The Replication Plugin Advanced Options section showed img_4.png — the Heartbeat panel. It now shows img_2.png, which is the publication panel the surrounding text actually describes. Confirmed by opening both images, not by filename.

Migration leftovers

Unrendered Jekyll/AsciiDoc that has been shipping as literal text: {prodname} → Debezium (8×), link: [x](y) and the: [x](y) → plain links, a raw link:url[text], a stray endif::community[]. Plus an unclosed markdown link (SSH tunnel), an unclosed backtick in the ms-sql cdc_get_net_changes link, and 4 absolute https://help.keboola.com/… self-links made root-relative.

Verification

  • npm run build clean, 306 pages.
  • audit-phase2: 45 broken links / 0 missing images, unchanged from main — and none of the 45 sits on a page touched here. The audit's overall total does improve, 147 → 143, from the four absolute help.keboola.com self-links made root-relative.
  • The five anchor fixes deliberately do not move that number: audit-phase2 validates link paths but not anchors. That gap is what the open feat(audit): validate link anchors, not just link paths #1073 closes — worth merging it to keep this class of defect from returning.

Reviewer note

Nothing here needed a product decision — every change is either an internal contradiction on the page itself or checkable against a source (component index, Debezium docs, the images). No VERIFY(owner) flags.

Context: this PR came out of a reconciliation of the June audits against the live sites. The same pass found more still-live findings — swapped OpenAI/Azure auth on the Generative AI page is the sharpest one — which will follow separately.

…lied

The June audit found these and opened #970, which was then closed on purpose
("audit-only task, no documentation edits to be merged — branch kept for
reference"). The second half of that plan never ran, so every finding below has
been live on help.keboola.com since. Recovered from the kept branch
devin/1781787795-db-extractor-docs-audit and re-verified against current main.

Wrong component, wrong database:
- Oracle and PostgreSQL both linked keboola.ex-db-mysql as "this connector".
  Now keboola.ex-db-oracle / keboola.ex-db-pgsql (both confirmed to exist via
  the public Storage API component index).
- The PostgreSQL credentials list described "the MySQL server" in all four
  fields (Host/Port/User/Password).
- PostgreSQL CDC described reading "the binlog" — that is MySQL's mechanism;
  PostgreSQL uses the write-ahead log (WAL), which the same page explains
  correctly a few sections earlier.
- The PostgreSQL data-type table was titled "MySQL datatypes are mapped to…".
- MySQL's column-mask notes linked Debezium's *PostgreSQL* connector docs;
  now the MySQL page (both #mysql-property-column-mask-* anchors verified live).

Broken anchors:
- /components/extractors/database/sqldb/#create-new-configuration does not
  exist — the heading is "Initial Setup". Fixed on all five pages that used it
  (index, ms-sql, mysql, oracle, postgresql), plus the page-local
  #log-based-cdc → #postgresql-log-based-cdc.

Wrong screenshot:
- The "Replication Plugin Advanced Options" section showed img_4.png, the
  Heartbeat panel. It now shows img_2.png, which is the publication panel the
  surrounding text describes. Confirmed by opening both images.

Migration leftovers and malformed markup:
- Unrendered Jekyll/AsciiDoc: {prodname} → Debezium (8×), "link: [x](y)" and
  "the: [x](y)" → plain links, a raw AsciiDoc link:url[text], a stray
  endif::community[].
- An unclosed markdown link (SSH tunnel) and an unclosed backtick in the
  ms-sql cdc_get_net_changes link.
- Absolute https://help.keboola.com/... self-links → root-relative (4×).

Verified: build clean (306 pages); audit-phase2 unchanged from main at 45
broken links / 0 missing images, and none of the 45 is on a page touched here.
The five anchor fixes do not move that number because audit-phase2 validates
link paths but not anchors — that is exactly what the open #1073 adds.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Aug 5, 2026

Copy link
Copy Markdown

PRDCT-342

@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview Aug 6, 2026 11:40pm

Request Review

…tor-fixes

# Conflicts:
#	src/content/docs/components/extractors/database/index.md
#	src/content/docs/components/extractors/database/ms-sql/index.md
#	src/content/docs/components/extractors/database/mysql/index.md
#	src/content/docs/components/extractors/database/oracle/index.md
#	src/content/docs/components/extractors/database/postgresql/index.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

june-audit-fixes Lands a finding from the June 2026 Devin docs audit that was never applied

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant