Skip to content

PRDCT-544: fold dev SSH-tunnel how-to into /components/extractors/database/#1019

Open
Iamfle4ka wants to merge 1 commit into
mainfrom
docs/xsite-ssh-tunnel-fold
Open

PRDCT-544: fold dev SSH-tunnel how-to into /components/extractors/database/#1019
Iamfle4ka wants to merge 1 commit into
mainfrom
docs/xsite-ssh-tunnel-fold

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

What

Cross-site consolidation DB SSH tunnel from the dev+help merge matrix — folds the dev-side setup how-to into the canonical help home so the topic lives on one page.

/components/extractors/database/ already carried the SSH-tunnel concept (what/why + the schema image) but punted the how-to to developers.keboola.com/integrate/database/. This brings that how-to in as a proper Diátaxis how-to subsection and retires the dev page.

  • Fold → new ### Setting Up an SSH Tunnel section: SSH proxy setup (Dockerfile), key-pair generation, connector fields, local tunnel — replacing the outbound "see the developer documentation" pointer.
  • 301redirect_from: /integrate/database/ on the canonical page (redirect-from integration; generated page verified → /components/extractors/database/).
  • Rewire → flip the SSH links in mysql/ and postgresql/ to the internal anchor #setting-up-an-ssh-tunnel (also fixes a broken markdown link in postgresql/).
  • Conserve-then-delete → all dev prose rehomed; nothing dropped.

VERIFY(owner)

Faithful fold of the published dev doc; a couple of specifics could use an owner/live-verify pass (happy to file a Linear accuracy issue like the PRDCT-47x handoffs if wanted):

  • The example Dockerfile uses ubuntu:14.04 (carried verbatim from the dev doc) — likely worth modernizing.
  • UI labels (Database Credentials, Enable SSH Tunnel, Test Credentials) and the localhost quirk should be confirmed against the current connector UI.

Out of scope

  • The full Diátaxis re-cut of the extractors/database section (PRDCT-342) — this is just the targeted cross-site fold.
  • Domain-level developers.keboola.com/integrate/database/ → help 301 (out-of-repo/ops layer).

Verification

  • npm run build — clean; [redirect-from] Generated 159 redirect pages (0 skipped); the /integrate/database/ redirect resolves to /components/extractors/database/ and the #setting-up-an-ssh-tunnel anchor renders.
  • node scripts/audit-phase2.mjs — no new issues in the edited pages; /integrate/database no longer flagged as an outbound dev seam.

Context

Second phase of the help + developers unification per the playbook: the dev-repo blocker for cross-site merges is now cleared (dev docs fetchable), so this is the first of the remaining dev→help folds. Follows the "how one merge runs" mechanic.

🤖 Generated with Claude Code

…ors/database/

Cross-site consolidation (DB SSH tunnel) from the dev+help merge matrix. The
help page already carried the SSH-tunnel concept but punted the setup how-to to
developers.keboola.com/integrate/database/. Fold that how-to in as a Diátaxis
how-to subsection so help is the single canonical home; 301 the retired dev path.

- Fold: SSH proxy setup, key-pair generation, connector fields, local tunnel.
- 301: add redirect_from /integrate/database/ on the canonical page.
- Rewire: flip the mysql + postgresql SSH links to the internal anchor
  (also fixes a broken markdown link in postgresql).
- Conserve-then-delete: all dev prose rehomed; nothing dropped.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 14, 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, Comment Jul 14, 2026 12:40pm

Request Review

@Iamfle4ka Iamfle4ka changed the title docs(extractors): fold dev SSH-tunnel how-to into /components/extractors/database/ PRDCT-544: fold dev SSH-tunnel how-to into /components/extractors/database/ Jul 15, 2026
@linear-code

linear-code Bot commented Jul 15, 2026

Copy link
Copy Markdown

PRDCT-544

@jordanrburger

Copy link
Copy Markdown
Contributor

Review summary

Verdict: merge-ready with one out-of-repo follow-up.

Cross-site fold of the SSH-tunnel how-to into the canonical help page, with both in-repo referrers (mysql, postgresql) rewired to the new #setting-up-an-ssh-tunnel anchor (grep confirms those were the only two). No in-repo page is moved/deleted, so no sidebar change is needed and there's no in-repo 404 risk. The PostgreSQL edit also fixes a genuinely broken markdown link (a missing closing paren).

Follow-up (out-of-repo):

  • The added redirect_from: /integrate/database/ generates a redirect on this site, not on the old developers.keboola.com domain. The real external URL will still 404 unless an ops-level 301 is configured outside this repo. The PR body scopes that out correctly — just track it so external inbound links don't dead-end.

Nits:

  • Example Dockerfile uses ubuntu:14.04 (carried verbatim from the old dev doc) — stale; worth modernizing (already flagged in the PR body).
  • UI labels (Database Credentials, Enable SSH Tunnel, Test Credentials) and the localhost quirk carried over unverified — confirm against the current connector UI.

Automated review pass (Claude Code), flagged for a human maintainer — not an approval.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev-docs-migration developers.keboola.com → help.keboola.com migration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants