fix: correct code-accuracy issues and doc hygiene in /extend/component/ (PRDCT-364) - #393
fix: correct code-accuracy issues and doc hygiene in /extend/component/ (PRDCT-364)#393Iamfle4ka wants to merge 1 commit into
Conversation
…t/ (PRDCT-364) - Fix validate_configuration() → validate_configuration_parameters() to match actual API - Update deprecated Bitbucket template links to GitHub cookiecutter-python-component - Update php-docker-application URL to php-component (current package name) - Fix HTTP → HTTPS for jeremydorn.com/json-editor link - Fix awkward phrasing 'Similar library is currently available also' - Fix empty link href for cookiecutter-python-component URL - Update dead travis-ci.org link to travis-ci.com - Fix garbled parameter name in python.md - Fix dead travis-ci.org/keboola/ex-docs-tutorial link in deployment - Fix 'input mapping' → 'output mapping' typo in output-mapping.md - Fix duplicate Step 4 numbering in debugging.md → Step 5 Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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 2/5) · profile docs
Needs human: two unverifiable code/repo correctness claims in a clean-looking hygiene PR.
Concerns:
extend/component/implementation/python.md: SDK method rename validate_configuration_parameters() unverified against sourceextend/component/index.md: PHP repo rename php-docker-application→php-component target existence unverified
Suggested reviewers: @keboola/docs
#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>
|
Superseded by connection-docs#1077, not by a PR in this repo — and that distinction is the reason this one sat for 43 days without ever being mergeable in a useful sense. Every page it touches moved to Worse, none of them had reached help: #1046 carried the unfixed text over. I grepped each fix against #1077 ports it hunk-for-hunk (a Branch stays cherry-pickable. |
2 participants
Jira issue(s): PRDCT-364
Changes:
Block A fixes (code-accuracy, needs_human=no):
implementation/python.md:ci.validate_configuration()→ci.validate_configuration_parameters()(verified againstkeboola/python-componentinterface.py:748)implementation/python.md: Replace deprecated Bitbucket template link withgithub.com/keboola/cookiecutter-python-componenttutorial/index.md: Remove stale Bitbucketkds_consulting_teamlink, point to cookiecutterindex.md: Updatephp-docker-applicationURL →php-component(current package name)Block C fixes (doc-hygiene):
tutorial/configuration.md: HTTP → HTTPS for jeremydorn.com linktutorial/configuration.md: Fix awkward phrasing ("Similar library is currently available also")tutorial/index.md: Fix empty link[URL]()→ proper hreftutorial/index.md: Update deadtravis-ci.org→travis-ci.comimplementation/python.md: Fix garbled text "somemyParameter_user_parameter" → "myParameter"deployment/index.md: Update deadtravis-ci.org/keboola/ex-docs-tutoriallinktutorial/output-mapping.md: Fix "input mapping" → "output mapping" typotutorial/debugging.md: Fix duplicate "Step 4" → rename to "Step 5"Not included (needs_human=yes, per audit firewall): Travis-to-GitHub-Actions restructuring, json-editor→RJSF reference rewrite, API docs link verification, component-generator image status. See full audit on PRDCT-364.
Release Notes
Justification, description
Documentation accuracy fixes identified by formal audit of
/extend/component/scope against source code. All changes are unambiguous corrections with zero behavioral or structural decisions.Plans for Customer Communication
N/A
Impact Analysis
N/A — documentation only, no code or service changes.
Deployment Plan
Merge to main; site rebuilds automatically.
Rollback Plan
Revert commit.
Post-Release Support Plan
N/A
Link to Devin session: https://app.devin.ai/sessions/5bbd04dbdb3a43dba7adaa3588c65039
Requested by: @Iamfle4ka