fix: correct inaccuracies and typos in /extend/ docs (PRDCT-366 audit) - #396
Closed
Iamfle4ka wants to merge 1 commit into
Closed
fix: correct inaccuracies and typos in /extend/ docs (PRDCT-366 audit)#396Iamfle4ka wants to merge 1 commit into
Iamfle4ka wants to merge 1 commit into
Conversation
Fixes from audit of /extend/generic-writer/, /extend/common-interface/, /extend/job-queue/, /extend/publish/ pages: Code-accuracy fixes: - A1: in-tables-manifests: table_metadata -> metadata (matches schema) - A2: in-tables-manifests: name refers to table name, not config name - A6: generic-writer/index: fix broken link to /overview/encryption/ - A7: generic-writer/config: Default Headers description said query params - A8: generic-writer/config: Headers description said query params - A13: config-file: fix colummns typo, write-alwayss typo, missing comma - A14: folders: add missing comma in workspace JSON example Doc-hygiene fixes: - C1: generic-writer/index: encripted -> encrypted - C2: generic-writer/config: truncated sentence in Default Headers - C3: generic-writer/config: turning of -> turning off - C4: generic-writer/config: enpoint_path -> endpoint_path - C5: generic-writer/config: fix empty dynamic functions link - C6: generic-writer/config: remove extra double-quote in Bearer example - C7: folders: my-inpupt.csv -> my-input.csv (x3) - C8: config-file: write-alwayss -> write-always - C9: logging: display events to end-users (missing to) - C10: logging: is filter -> is filtered - C11: development-branches: accross -> across - C12: job-queue: have an access -> have access - C13: folders: fix relative link missing leading / Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 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:
|
Iamfle4ka
marked this pull request as ready for review
July 10, 2026 13:53
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: needs_human (risk 2/5) · profile docs
Solid docs cleanup, but two manifest-schema claims in in-tables-manifests.md need product-team confirmation before shipping.
Concerns:
extend/common-interface/manifest-files/in-tables-manifests.md: Schema-key change table_metadata→metadata asserts manifest structure; unverifiable from diff.extend/common-interface/manifest-files/in-tables-manifests.md:namenode redefined as table name; product-behaviour claim needs confirmation.
Suggested reviewers: @keboola/docs
Collaborator
Author
|
Superseded, but split three ways — this PR straddled the migration boundary, which is why it was already
The bot's two concerns, both on
Branch stays cherry-pickable. |
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
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.
Jira issue(s): PRDCT-366
Changes:
Unambiguous fixes from the developers-docs audit of
/extend/generic-writer/,/extend/common-interface/,/extend/job-queue/,/extend/publish/(22 pages, full audit log posted as comment on PRDCT-366).Code-accuracy fixes (Block A,
needs_human=no):in-tables-manifests.md: JSON example usedtable_metadata— actual schema field ismetadata(verified:docker-bundle/Resources/schemas/in-tables-manifest.json,input-mapping/src/Helper/ManifestCreator.php:41)in-tables-manifests.md:namedescribed as "component configuration name" — it's the table name (e.g.datafromin.c-docker-demo.data)generic-writer/index.md: broken link(overview/encryption/)→(/overview/encryption/)generic-writer/configuration.md: Default Headers section said "default query parameters" → "default headers"generic-writer/configuration.md: Headers section said "default query parameters" → "request headers"config-file.md:colummns→columns,write-alwayss.csv→write-always.csv, added missing commafolders.md: missing comma in workspace JSON exampleDoc-hygiene fixes (Block C):
encripted→encryptedturning of→turning offenpoint_path→endpoint_path[dynamic functions]()link → correct anchormy-inpupt.csv→my-input.csv(×3)write-alwayss.csv→write-always.csvis filter→is filteredaccross→acrosshave an access→have access/in folders.mdNot in this PR (flagged
needs_human): A3 (metadata format structure), A4/A5 (missing schema fields), A9 (UPDATEHTTP method), A10 (beta warning), A11 (deprecated workspaces), A12 (Apiary link), A15 (column_types schema gap).Zero
needs_humanrows in this diff. All changes are mechanical corrections verified against source code inkeboola/docker-bundleandkeboola/input-mapping.Link to Devin session: https://app.devin.ai/sessions/5d17311036ad4ac098285c228d6bfc0e
Requested by: @Iamfle4ka