Skip to content

fix: unambiguous doc fixes from /integrate/ audit (PRDCT-368) - #395

Closed
Iamfle4ka wants to merge 4 commits into
mainfrom
devin/1782145854-PRDCT-368-integrate-audit-fixes
Closed

fix: unambiguous doc fixes from /integrate/ audit (PRDCT-368)#395
Iamfle4ka wants to merge 4 commits into
mainfrom
devin/1782145854-PRDCT-368-integrate-audit-fixes

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-368

Changes:

  • jobs/index.md: Fix broken [job types](todo) link → #job-type anchor (A2); fix typos: it'sits (C2), cratedcreated (C1), and erroran error (C3)
  • variables/index.md: Add missing comma in Step 3 JSON example (A6); fix unclosed string quote in Option 2 JSON (A7); replace localhost:4000 URL with relative path (A5)
  • artifacts/index.md: Change config key \"orchestration\"\"shared\" to match job-queue code (Artifacts.php defines public Shared $shared) (A13)
  • artifacts/tutorial.md: Fix typo configurtionconfiguration (C8)
  • data-streams/overview/index.md: Change \"type\": \"json\"\"type\": \"path\" in path column example per Stream API OpenAPI enum (A10)

All fixes are unambiguous (zero needs_human rows). Full audit log with Block 0/A/B/C and 8 needs_human items posted as a comment on PRDCT-368.


Release Notes

Justification, description

Documentation-only fixes for accuracy issues found during the /integrate/ audit. No functional changes.

Plans for Customer Communication

N/A

Impact Analysis

N/A — doc-only, no code changes.

Deployment Plan

Merge to main triggers Jekyll rebuild on developers.keboola.com.

Rollback Plan

Revert merge commit.

Post-Release Support Plan

N/A

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

nikita.zverev2 and others added 4 commits June 22, 2026 16:31
- Replace broken [job types](todo) link with #job-type anchor (A2)
- Fix 'it's' → 'its' possessive (C2)
- Fix 'crated' → 'created' typo (C1)
- Fix 'and error' → 'an error' typo (C3)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
- Add missing comma after closing brace in Step 3 JSON (A6)
- Fix unclosed string quote in Option 2 JSON (A7)
- Replace localhost:4000 URL with relative path (A5)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
- Change 'orchestration' to 'shared' in config example to match code (A13)
- Fix 'configurtion' → 'configuration' typo (C8)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
- Change "type": "json" to "type": "path" per Stream API OpenAPI enum (A10)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@Iamfle4ka Iamfle4ka self-assigned this Jun 22, 2026
@linear

linear Bot commented Jun 22, 2026

Copy link
Copy Markdown

PRDCT-368

@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

@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

Needs human: three code-example/link changes assert correctness against sources not verifiable from the diff.

Concerns:

  • integrate/artifacts/index.md: Config key "orchestration"→"shared" asserts match to external Artifacts.php; unverifiable from diff.
  • integrate/data-streams/overview/index.md: Example "type": json→path claims OpenAPI-enum conformance; unverifiable from diff.
  • integrate/jobs/index.md: New anchor #job-type target heading existence unverifiable from diff.

Suggested reviewers: @keboola/docs

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Superseded by #410, which carries this PR's fixes except two lines that #402 (newer, still open) already handles. Open 43 days with no human review.

One fix here is wrong and was deliberately not carried over. It rewrites the leaked http://localhost:4000/integrate/variables/#step-2--create-default-values-for-variable link but keeps the singular slug, while the heading is ### Step 2 -- Create Default Values for **Variables**. The link would have stayed broken. #402 fixes the same line with the correct plural, so its version is the one to keep.

Also dropped as a duplicate: [job types](todo)(#job-type). #402 uses the absolute /integrate/jobs/#job-type, which is the more consistent form. The bot flagged that anchor as unverifiable; the ### Job Type heading exists, so #402's link resolves.

The bot's two other concerns are confirmed, both from each page's own content:

  • orchestrationshared in the artifacts example: the page states there are three types, runs, custom and shared, and that block claims to show "all artifact types".
  • "type": "json""path" in Data Streams: the column-type table has no json type, and the example sits under ### Path.

Branch stays cherry-pickable.

@Iamfle4ka Iamfle4ka closed this Aug 4, 2026
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