fix: consolidate the June docs audit for the pages that stay on dev (PRDCT-365/366/367/368/369) - #410
fix: consolidate the June docs audit for the pages that stay on dev (PRDCT-365/366/367/368/369)#410Iamfle4ka wants to merge 2 commits into
Conversation
Replaces six unreviewed PRs from 2026-06-22 (#391, #392, #394, #395, #396, #398 — PRDCT-365/366/367/368/369) with one branch off current main, carrying only the fixes that belong on developers.keboola.com and only once. Dropped from the June set: - Everything under extend/component/**, extend/common-interface/**, extend/job-queue/ and extend/publish/ — those pages moved to help in keboola/connection-docs#1046 and #406 turns them into redirect stubs, so fixing them here changes nothing a reader can see. Their fixes go to connection-docs instead; #1046 carried the *unfixed* text over, so none of them had reached help. - Three hunks that #402 (PRDCT-480, open, newer) already fixes: the pagenum -> offset link, the `[job types](todo)` link, and the localhost:4000 link in integrate/variables. #395's version of that last one is wrong — it targets #step-2--create-default-values-for-variable, but the heading is "Step 2 -- Create Default Values for Variables". #402 has the correct plural. Everything substantive was verified against source rather than taken from the June diffs: - storage-api-php-client throws `InvalidArgumentException('url must be set')`, and the R client's `initialize(token, url, ...)` has no default for `url` — so the PHP and R examples were unrunnable without it, and the R page's "the only required argument is a token" was wrong. - The OAuth row for US Virginia GCP pointed at europe-west3, a copy-paste from the EU Frankfurt row. `GET connection.us-east4.gcp.keboola.com/v2/storage` reports `oauth -> https://oauth.us-east4.gcp.keboola.com`, matching the other 18 rows of that table. - `#regions-and-endpoints` is dead — the heading is "## Stacks and Endpoints". Fixed in overview/encryption.md (from #391) and in the one other page that stays (integrate/storage/docker-cli-client.md); the remaining instances sit on retired pages and are fixed on the help side instead. - Artifacts: the "all artifact types" example used `orchestration`, but the page documents exactly three types — `runs`, `custom`, `shared`. - Data Streams: the Path example used `"type": "json"`; the column-type table has no `json` type, and the section documents `path`. - `#storage-api-clients` and `#dynamic-functions` both resolve to real headings; the previous `#clients` and empty `[dynamic functions]()` did not. - The period removed after example [EX131] was mid-sentence — the sentence continues with example [EX133] on the next line. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Two hunks in this PR were not described in the section above, because the summary I wrote it from used a filter that silently dropped every changed markdown list item (a list line
While re-checking, I also re-ran the #402 overlap with a correct filter, comparing changed-line sets per file rather than eyeballing a summary: 6 files are touched by both PRs and 0 changed lines are shared — every overlap is complementary. So the two can merge in either order. The remaining |
1 participant
Consolidates six unreviewed PRs from 2026-06-22 — #391, #392, #394, #395, #396, #398 (PRDCT-365/366/367/368/369) — into one branch off current
main, carrying only the fixes that belong ondevelopers.keboola.com, and only once.The June batch was one audit split by area. None of it was ever reviewed (only
keboola-pr-reviewer-bot), all six had fallen behindmain, #396 was already conflicting, and #402 (PRDCT-480, opened 2026-07-10) partially redid the same territory — so the same lines were queued in two or three places at once.What is in
overview/#regions-and-endpointsanchor, two grammar fixesautomate/set-schedule.mdintegrate/storage/urlargument added to the PHP and R client examples, dead#clientsanchor, Apiary →api.keboola.comlink, typosintegrate/orchestration→sharedin the artifacts example,"type": "json"→"path"in Data Streams, invalid JSON in the variables examples, typosextend/generic-extractor/], a garbleduserDatasentenceextend/generic-writer/[dynamic functions]()link,enpoint_path, two "default query parameters" that mean headers, a stray quote in the Bearer exampleWhat was dropped, and why
Retired pages. Everything the June PRs touched under
extend/component/**,extend/common-interface/**,extend/job-queue/andextend/publish/is gone from here. Those pages moved to help in connection-docs#1046 and #406 turns them intoredirect_tostubs — fixing them in this repo changes nothing a reader can see. That is the whole of #393 and six of the eight files in #396.They are not lost: #1046 carried the unfixed text to help, so none of those fixes had reached readers. They are re-applied against
helpin connection-docs#1077, which also picks up defects the migration introduced.Three hunks #402 already fixes — the
pagenum→offsetlink,[job types](todo), and thelocalhost:4000link inintegrate/variables. #402 is newer and stays open; this PR stays off those lines so the two do not collide. Note #395's version of the third one is wrong: it targets#step-2--create-default-values-for-variable, but the heading is### Step 2 -- Create Default Values for Variables. #402 has the correct plural, so its version is the one to keep.#397 and #402 are untouched and should still be merged. Per
DEV-MIGRATION-PLAN.md, dev/cli/is the keboola-as-code CLI — a different product from the kbagent CLI documented athelp.keboola.com/cli/(#1015), with/cli/keboola-as-code/already planned for it. Not a superseded copy.Verification
Every substantive claim was checked against source rather than taken on faith from the June diffs:
storage-api-php-clientClient::__constructthrowsInvalidArgumentException('url must be set'). R client:initialize(token, url, ...)insapi-r-client/R/client.Rhas no default forurl(its own docstring calling it "Optional" is wrong). Both sets of examples were unrunnable as written.oauth.europe-west3.gcp.keboola.com, copy-pasted from the EU Frankfurt row.GET connection.us-east4.gcp.keboola.com/v2/storagereturnsoauth → https://oauth.us-east4.gcp.keboola.com, matching the other 18 rows.## Stacks and Endpoints, so#regions-and-endpointsresolves nowhere. Fixed on the two pages that stay; the rest of the instances are on retired pages and are handled help-side.orchestration; the page documents exactlyruns,custom,shared."type": "json"; the column-type table has nojsontype.#storage-api-clientsand#dynamic-functionsboth resolve to real headings (## Storage API Clients,## Dynamic Functions); the previous#clientsand empty()did not.[EX131]: the period removed was mid-sentence — the sentence continues with[EX133]on the next line.Build: not run locally — this repo builds through
docker composeand there is no container runtime on this machine, so theBuildworkflow here is the first build.Once this lands
Close #391, #392, #394, #395, #396 and #398 as superseded by this PR (branches stay cherry-pickable). #393 is superseded by connection-docs#1077. #397 and #402 continue on their own.