Remove the Keboola as Code CLI documentation, redirect to the repository - #417
Conversation
The CLI reference moves to the tool's own repository so it survives the retirement of this domain: keboola/keboola-as-code#2654 puts all 59 pages under docs/user-docs/. Content and the 21 images are deleted here. What stays is one redirect stub per page — permalink plus redirect_to — so deep links that exist in the wild keep working until the domain itself goes away. jekyll-redirect-from is already a plugin on this site. Delete the stubs together with the domain. The nav entry collapses from 129 lines to a single "CLI (moved)" row. Nothing else in developers-docs links into /cli/, so no inbound links break.
…epo root The 59 CLI rows pointed at github.com/keboola/keboola-as-code — the repository, not the page. That is fine as a statement of intent and useless as an edge rule: a reader following developers.keboola.com/cli/commands/sync/pull/ would land on a monorepo root and have to hunt. keboola-as-code#2654 lands the pages at a predictable path, so each row now carries the file it actually became — commands/sync/pull/ → docs/user-docs/commands/sync/pull.md, and so on for all 59. The same table now exists three times over and agrees with itself: here, in the redirect stubs of the developers-docs deletion PR (keboola/developers-docs#417), and in the ported tree itself. Written into PLACEMENT-MAP.md rather than only into the TSV: --gen regenerates the TSV from the map, so a hand-edited TSV would have been silently reverted by the next person to run it. Verified by regenerating — the destinations survive. The lossy-parse guard earned its keep here: a first attempt at the map edit ate a space before the target column, dropped the parse to 116/175 rows, and the generator refused to write the result instead of shipping a truncated contract.
keboola-as-code#2654 was closed, so docs/user-docs/ will not exist and the per-page destinations these stubs carried would have been 404s. Every stub now points at the repository root, which is what remains true: the tool lives there, the documentation does not. The note is corrected too — the content survives in THIS repository's git history, not in keboola-as-code's, since it was never merged there.
|
Updated after keboola/keboola-as-code#2654 was closed. The stubs pointed at The merge-order caveat in the description is gone with it: there is nothing to land first. #397 is closed as moot, with its verified corrections written into the closing comment so the next person auditing this CLI does not re-derive them. What this costs, recorded once so the decision is documented rather than discovered later: end-user installation instructions — brew tap, apt/rpm/apk with GPG key import, WinGet, Chocolatey, Scoop, MSI — exist nowhere except the pages this PR deletes. And 21 of the CLI's 68 embedded That is the owner's call and this PR implements it. Flagging it here only so it is on the record next to the deletion, not to reopen it. |
2 participants
Martin's
mazací PR, paired with keboola-as-code#2654, which puts all 59 pages underdocs/user-docs/in the tool's own repository.Deleted: the content of all 59
/cli/pages and the 21 images. 4,317 lines gone.Kept: one redirect stub per page —
permalink+redirect_to— pointing at the exact new page, not just the repo root.jekyll-redirect-fromis already a plugin here, so these work without new tooling. Deep links to things like/cli/commands/sync/pull/exist in the wild; the stubs keep them alive until the domain itself goes, and should be deleted with it.Nav: the CLI block collapses from 129 lines to a single
CLI (moved)row.Nothing else in this repo links into
/cli/— checked; the only inbound links were from the CLI pages themselves.One thing to decide before merging
This supersedes #397 ("correct CLI docs against
kbc --help", 14 files, mergeable). Rather than let those fixes die with the pages, #2654 was generated from #397's head, so all of them are already in the new home:remote table unload/download--timeout5m, thedbt generate envcopy-paste error,local create row, the missing--cleanupand--without-decompressflags,remote file upload --file-name/--file-tags, and two wrong workspace links.So #397 can be closed as superseded once #2654 lands. Merging this PR before #2654 would drop those corrections on the floor — please land #2654 first.
For the edge 301
developers.keboola.com/cli/**needs a destination at the CDN. The per-page mapping is in the stubs, and I can hand over a flat TSV of all 59route → GitHub URLpairs on request — that is the accurate table, not a wildcard to the repo root.🤖 Generated with Claude Code