Skip to content

PRDCT-657: port the legacy Keboola-as-Code CLI docs under /cli/keboola-as-code/ - #1093

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
PRDCT-657-kac-port
Closed

Iamfle4ka wants to merge 1 commit into
mainfrom
PRDCT-657-kac-port

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Linear: PRDCT-657 · closes the conservation gap found while building the redirect contract in #1091.

Why

The 59 legacy Keboola-as-Code pages had no home on help. They were meant to land at /cli/keboola-as-code/**, but that tree existed in no branch and no open PR — phase-1 (#1027) was closed, and #1015 gave /cli/ to kbagent. Meanwhile cli/index.md still sent readers to the live developers.keboola.com/cli/. Retiring the dev domain today would have 404'd all 59 pages and broken help's own pointer.

This is what PLACEMENT-MAP always assumed for these rows: port as-is, relabel, deprecation notice, content untouched.

What's here

  • 59 pages at /cli/keboola-as-code/** + 21 images, re-cut from the phase-1 branch where the move and internal link rewriting were already done. Content is not rewritten.
  • pagefind: false on all 59 — a deprecated tool shouldn't compete with the current CLI docs in site search or feed Kai. Verified: none of the 59 carry data-pagefind-body; /cli/ still does.
  • Nav: one entry under the existing CLI group, not the full 59-page tree — reachable, not promoted. It renders as "Keboola as Code CLI" (the sidebar generator emits bare slugs for leaf items and takes the page title).
  • cli/index.md now points at /cli/keboola-as-code/ instead of the live dev site.

Defects fixed on the way in (not "as-is" — these would have shipped broken)

What Where Why it mattered
18 kramdown tables → GFM 16 files, 15 pages They rendered as pipe-soup — <table> count was literally 0 on the command-reference pages, the most useful pages in the tree
7 empty spacer rows 2 files kramdown artifacts, render as blank table rows in GFM
3 empty [Example Use Cases]() links index.md dead links inherited from the dev site → now devops-use-cases/
Indented closing fence dbt/index.md rendered fine, but tripped the audit's fence check
title: CLI → Keboola as Code CLI index.md would have been a second "CLI" competing with kbagent's page

Verification

  • npm run build clean, 308 → 367 pages (+59); all 59 present in dist/
  • audit-phase2.mjs: only 5 findings attributable to these pages, all links to targets that haven't landed yet — 4 × /overview/encryption/#encrypting-data-with-api (not migrated anywhere; UNSURE row in PLACEMENT-MAP) and 1 × /extend/generic-extractor/ (lands with PRDCT-552: Generic Extractor under Components › Data Source Connectors (re-cut off main) #1054). Everything else in the audit is pre-existing on main.
  • Tables re-verified in dist/ after conversion: commands index 3, dbt 1, remote/table 1.

Open for you

Banner wording. The page carries :::caution[Deprecated in the future] pointing at kbagent. Do you want a concrete retirement date instead? That's the same TODO(human-review, Jordan) already sitting on the CLI page — it's a one-line edit, so I didn't block the port on it.

I also haven't audited how stale the content is — there's no local devdocs clone to diff against, and with an explicit deprecation banner it seemed second-order. Say the word if you want that checked before this merges.

🤖 Generated with Claude Code

…a-as-code/

The 59 KaC pages had no home on help: phase-1 (#1027) was closed and #1015 gave
/cli/ to kbagent, so retiring developers.keboola.com would have 404'd all of them
and broken help's own pointer to the legacy tool.

Ported as-is from the phase-1 branch, where the move and internal link rewriting
were already done. On top of that:

- pagefind: false on all 59 — a deprecated tool must not compete with the current
  CLI docs in site search, or feed Kai.
- 18 kramdown tables converted to GFM. They rendered as pipe-soup (0 <table> tags)
  on 15 command-reference pages — the most useful pages in the tree.
- 3 empty [Example Use Cases]() links pointed at devops-use-cases/.
- cli/index.md now points at /cli/keboola-as-code/ instead of the live dev site.

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

linear-code Bot commented Aug 19, 2026

Copy link
Copy Markdown

PRDCT-657

@vercel

vercel Bot commented Aug 19, 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 19, 2026 4:55pm

Request Review

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Closing unmerged — David's call: the 59 legacy Keboola-as-Code pages are not coming into help.

Instead the kbagent banner names the tool's own repository, keboola/keboola-as-code, and every developers.keboola.com/cli/ link in the docs now points there. That work is in #1094 (six links across five pages, which clears the last dev-CLI reference in the docs).

The port itself was sound — 59 pages, pagefind: false, 18 kramdown tables repaired — but there is no reason to carry a deprecated tool's reference into help when the repository already hosts it and survives the domain retirement.

One consequence worth recording for the retirement (PRDCT-565): those 59 dev URLs now resolve to nothing on help. developers.keboola.com/cli/** is 59 of the 67 remaining rows in the conservation contract, so the edge 301s need an explicit destination for them — the repository, or /cli/. Noting it on #1091 so the contract does not silently claim conservation it cannot deliver.

@Iamfle4ka Iamfle4ka closed this Sep 3, 2026
Iamfle4ka pushed a commit that referenced this pull request Sep 3, 2026
David's call (2026-09-02): the legacy Keboola-as-Code pages are not ported into
help. The kbagent banner names github.com/keboola/keboola-as-code instead, and
every dev-CLI link in the docs now points there (#1094). #1093 is closed.

The contract has to say so, otherwise it reports 59 URLs as conservation
failures forever. Adds an `external` status: the destination is kept verbatim
rather than forced into a help path, --build stops expecting those URLs in dist
and reports them separately, and --live checks the 301 against the off-site URL
instead of prefixing help's host.

The honest reading of the gate on today's main changes accordingly:

  before   67 resolve nowhere
  after    59 off-site by decision, 8 genuinely unresolved

The remaining 8 are the PRDCT-550 rows — /integrate/ artifacts and jobs,
/automate/ run-job and set-schedule, /overview/ api and encryption.

Note for the retirement (PRDCT-565): these 59 are the one group whose 301 does
not point at help. The edge rules need `developers.keboola.com/cli/**` sent to
the repository — or to /cli/, whose banner routes onward — and that choice is
now visible in the map rather than implied.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview — 6e3c9679 Deployed Aug 19, 2026 by vercel[bot]
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.

1 participant