PRDCT-543: Extending Keboola as its own top-level section - #1046
Merged
Conversation
Per the 2026-07-27 nav pivot: fold the developer docs into help incrementally, section by section, with no sidebar dev/help flag — the dev-audience signal lives on the page instead. First unit: promote the "Extending Keboola" content (build-a-component tutorial, common interface, job queue, publishing) to its own top-level sidebar section, right before External Integrations. Self-contained off main — independent of the phase-1 big-bang stack (#1027). - src/content/docs/extend/** (42 pages) at their existing /extend/ slugs (URLs unchanged — nav move, no re-slug, no redirects needed) - public/extend/** (98 images + data.zip) — only the referenced assets; co-located source-image orphans dropped - _data/navigation.yml: new top-level "Extending Keboola" section before External Integrations; src/sidebar.mjs regenerated (gen:sidebar) - extend/index.md: page-level ":::note[Mostly for developers]" — the pivot's on-page signal (skip if you don't code, or hand it to your agent) generic-extractor and Variables API are handled by their own batches (#1031/#1033) and stay in Components/Transformations. Build clean (298 pages); audit: 0 missing images; the 43 broken internal links are forward-refs to not-yet-migrated dev pages (overview/api, encryption, storage/api, generic-extractor, integrate/jobs) and heal as later units land — acceptable during the merge. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
keboola-pr-reviewer-bot
left a comment
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: needs_human (risk 4/5) · profile docs
Large nav-pivot migration adding 42 dev pages plus navigation/sidebar restructure — needs the docs team, not auto-approve.
Concerns:
_data/navigation.yml: New top-level nav section — structure-data change requires human review.src/sidebar.mjs: Generated sidebar regenerated; nav rendering change across the site.src/content/docs/extend/common-interface/config-file/index.md: Line 28 'Oauth2' wrong casing; canonical is 'OAuth2'.- + 2 more concerns — see Check Run summary.
Suggested reviewers: @keboola/docs
This was referenced Jul 28, 2026
Iamfle4ka
added
the
dev-docs-migration
jordanrburger
approved these changes
Jul 28, 2026
jordanrburger
left a comment
jordanrburger
left a comment
Contributor
There was a problem hiding this comment.
Looks good. Don't forget about the companion PR to dev docs as a followup
Iamfle4ka
enabled auto-merge
July 29, 2026 23:58
Iamfle4ka
pushed a commit
that referenced
this pull request
Aug 3, 2026
The map still routed the 42 dev /extend/** pages to /components/development/**, a section that was never built: Jordan approved /extend/ as its own top-level section instead (#1046, merged 2026-07-29, commit 8504c9d). Every one of those 42 targets 404'd, so deleting the dev pages would have orphaned their URLs. #1046 preserved the dev path structure 1:1, so these become identity redirects across domains (developers.keboola.com/extend/X/ -> help.keboola.com/extend/X/). Verified: all 42 targets now resolve in a production build; conservation failures drop from 162 to 117, and the remaining 117 are units whose help pages are not on main yet (#1023, #1051-#1054, artifacts, jobs, overview/api, encryption, CLI). The NEW-sections table entry is marked superseded rather than deleted so the provenance of the change stays readable. Left untouched: the 3 rows still targeting /components/development/ (artifacts x2, overview/encryption). They are flagged `unsure` and are genuine open owner calls. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This was referenced Aug 3, 2026
Iamfle4ka
pushed a commit
that referenced
this pull request
Aug 4, 2026
#1046 moved 41 pages from developers.keboola.com to /extend/**. Two audit PRs on that repo — keboola/developers-docs#393 and #396, both opened 2026-06-22 and never reviewed — had already found defects on those pages, so the copies that landed here are the *unfixed* ones. Grepping for each fix confirmed every one of them is still present on help. Carried over from #393 and #396: - `ci.validate_configuration(...)` is not a method on CommonInterface; the real one is `validate_configuration_parameters` (python-component interface.py:748). The published example raises AttributeError. - The Python library link pointed at a superseded Bitbucket template (still reachable, last touched 2023) and the PHP one at keboola/php-docker-application, since renamed to keboola/php-component. The Python link now targets the actual example file in the cookiecutter template, since the prose promises "an actual working example" and the template root is not one. - Invalid JSON in four examples: a missing comma before `write_always`, a missing comma after the `schema` member, a missing comma between the `input` and `output` objects, and a trailing comma in the ABS workspace credentials. - `"colummns"`, `write-alwayss.csv`, `my-inpupt.csv` (x4), `accross`, "display events Keboola end-users", "is filter for sensitive values", "does not have an access to". - The input-table manifest's `name` node holds the table name, not the name of the component configuration (input-mapping ManifestCreator.php:23). - The output-mapping page said "Implementing the input mapping requires...". - Two `### Step 4` headings in a row on the debugging page; the second is 5. Nothing in either repo links to that anchor. - `somemyParameter_user_parameter`, where the JSON below it says `myParameter`. Broken links found while checking, not from either PR: - help has no /overview/api/ page — it 404s, that reference lives only on dev docs — yet nine links in the migrated pages pointed at it as a site-relative path. Broken in production right now. Repointed at developers.keboola.com. - The anchor was dead too: the heading is "## Stacks and Endpoints", so `#regions-and-endpoints` resolved nowhere. Three native help pages carried the same dead anchor, which leaves none in the repo. - Four links to `/extend/component/running/#preparing-the-data-folder`, whose heading is "## Preparing Data folder". Repointed at the slug that exists, rather than renaming the heading, which would break the links #406 repoints. - `debugging/#step-2--build-the-image`, whose heading is "### Step 2 -- Build Image". Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This was referenced Aug 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
First unit of the 2026-07-27 nav pivot: fold the developer docs into help incrementally, section by section, with no sidebar dev/help flag — the dev-audience signal lives on the page instead.
This PR promotes the Extending Keboola content (build-a-component tutorial, common interface, job queue, publishing) to its own top-level sidebar section, right before External Integrations. It is self-contained off
main— independent of the phase-1 big-bang stack (#1027), so it can be reviewed and merged on its own. This is the "developers shrinks, help grows, repeat" model.Changes
src/content/docs/extend/**— 42 pages at their existing/extend/slugs. URLs unchanged → nav move, no re-slug, no redirects.public/extend/**— 98 referenced images +data.zip. Only the referenced assets are brought; co-located source-image orphans dropped._data/navigation.yml— new top-levelExtending Keboolasection before External Integrations;src/sidebar.mjsregenerated viagen:sidebar(do not hand-edit).extend/index.md— page-level:::note[Mostly for developers]— the pivot's on-page signal ("skip it if you don't code, or hand it to your AI agent").Not in scope
developers.keboola.comPR (keboola/developers-docs) is a follow-up.Verification
npm run buildclean — 298 pages.node scripts/audit-phase2.mjs: 0 missing images, 0 new old-docs link smells from these pages.43 broken internal links are all forward-references to not-yet-migrated dev pages and heal as later units land:
/storage/api/**/overview/api/**/components/extractors/generic-extractor/**/overview/encryption/**/integrate/jobs/**/transformations/variables/api/Broken links during the incremental merge are acceptable per Jordan's 2026-07-27 call; enumerated here so they're known.
🤖 Generated with Claude Code