fix: unambiguous doc fixes from /integrate/ audit (PRDCT-368) - #395
fix: unambiguous doc fixes from /integrate/ audit (PRDCT-368)#395Iamfle4ka wants to merge 4 commits into
Conversation
- 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>
🤖 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
There was a problem hiding this comment.
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
|
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 Also dropped as a duplicate: The bot's two other concerns are confirmed, both from each page's own content:
Branch stays cherry-pickable. |
Jira issue(s): PRDCT-368
Changes:
[job types](todo)link →#job-typeanchor (A2); fix typos:it's→its(C2),crated→created(C1),and error→an error(C3)localhost:4000URL with relative path (A5)\"orchestration\"→\"shared\"to matchjob-queuecode (Artifacts.phpdefinespublic Shared $shared) (A13)configurtion→configuration(C8)\"type\": \"json\"→\"type\": \"path\"in path column example per Stream API OpenAPI enum (A10)All fixes are unambiguous (zero
needs_humanrows). Full audit log with Block 0/A/B/C and 8needs_humanitems 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