Skip to content

fix: correct inaccuracies and typos in /extend/ docs (PRDCT-366 audit) - #396

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1782145894-PRDCT-366-audit-fixes
Closed

fix: correct inaccuracies and typos in /extend/ docs (PRDCT-366 audit)#396
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1782145894-PRDCT-366-audit-fixes

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

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):

  • A1 in-tables-manifests.md: JSON example used table_metadata — actual schema field is metadata (verified: docker-bundle/Resources/schemas/in-tables-manifest.json, input-mapping/src/Helper/ManifestCreator.php:41)
  • A2 in-tables-manifests.md: name described as "component configuration name" — it's the table name (e.g. data from in.c-docker-demo.data)
  • A6 generic-writer/index.md: broken link (overview/encryption/)(/overview/encryption/)
  • A7 generic-writer/configuration.md: Default Headers section said "default query parameters" → "default headers"
  • A8 generic-writer/configuration.md: Headers section said "default query parameters" → "request headers"
  • A13 config-file.md: colummnscolumns, write-alwayss.csvwrite-always.csv, added missing comma
  • A14 folders.md: missing comma in workspace JSON example

Doc-hygiene fixes (Block C):

  • C1: encriptedencrypted
  • C2: truncated sentence in Default Headers section
  • C3: turning ofturning off
  • C4: enpoint_pathendpoint_path
  • C5: empty [dynamic functions]() link → correct anchor
  • C6: extra double-quote in Bearer example
  • C7: my-inpupt.csvmy-input.csv (×3)
  • C8: write-alwayss.csvwrite-always.csv
  • C9: missing "to" in logging.md
  • C10: is filteris filtered
  • C11: accrossacross
  • C12: have an accesshave access
  • C13: relative link missing leading / in folders.md

Not in this PR (flagged needs_human): A3 (metadata format structure), A4/A5 (missing schema fields), A9 (UPDATE HTTP method), A10 (beta warning), A11 (deprecated workspaces), A12 (Apiary link), A15 (column_types schema gap).


Zero needs_human rows in this diff. All changes are mechanical corrections verified against source code in keboola/docker-bundle and keboola/input-mapping.

Link to Devin session: https://app.devin.ai/sessions/5d17311036ad4ac098285c228d6bfc0e
Requested by: @Iamfle4ka

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>
@Iamfle4ka Iamfle4ka self-assigned this Jun 22, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@linear

linear Bot commented Jun 22, 2026

Copy link
Copy Markdown

PRDCT-366

@Iamfle4ka
Iamfle4ka marked this pull request as ready for review July 10, 2026 13:53

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: name node redefined as table name; product-behaviour claim needs confirmation.

Suggested reviewers: @keboola/docs

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Superseded, but split three ways — this PR straddled the migration boundary, which is why it was already CONFLICTING and never merged. Open 43 days with no human review.

The bot's two concerns, both on in-tables-manifests.md:

  • table_metadatametadata: already correct on helpdocs(input-mapping): AJDA-2714 document description and schema fields in input table manifest #400 landed that part here in the meantime, and the help copy shows metadata. Correctly skipped in #1077.
  • name is the table name, not the component configuration name — confirmed. keboola/input-mapping, src/Helper/ManifestCreator.php:23: 'name' => $tableInfo['name'], taken from the Storage table detail beside 'id' => $tableInfo['id']. The page's own example agrees ("id": "in.c-docker-demo.data" / "name": "data"). The old sentence was flatly wrong, and that wrong sentence is still live on help today — #1077 fixes it.

Branch stays cherry-pickable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants