Skip to content

docs: fix ERP extractor docs accuracy issues (PRDCT-351)#972

Draft
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1781879186-prdct-351-erp-docs-audit
Draft

docs: fix ERP extractor docs accuracy issues (PRDCT-351)#972
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1781879186-prdct-351-erp-docs-audit

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-351

Changes:

Code-accuracy fixes (verified against keboola/component-k2 configSchema + source):

  • Fix K2 SSH field names to match actual UI titles from configSchema.json:
    • "Remote Address" → "K2 API Source Address" (configSchema.json:78-79)
    • "Remote Port" → "K2 API Port" (configSchema.json:82-83)
  • Add undocumented #private_key_password field to K2 SSH section (configSchema.json:63-68, used in ssh_utils.py:16-17)
  • Fix broken K2 documentation link: k2gaia/02/en/10023272.htm#o57577 → 404; updated to working k2gaia/12/en/10023272.htm
  • Fix source_url description to match schema: "root address of API" → "address that is used to query the K2 API" (configSchema.json:94)

Doc hygiene:

  • Convert 3× absolute help.keboola.com links to root-relative (K2 line 30, NetSuite lines 21, 30)
  • Fix "Source Url" → "Source URL" capitalization
  • Align ERP index title with sibling pages: "ERP" → "ERP Data Source Connectors"
  • Add missing redirect_from: - /extractors/erp/

Items requiring human decision (not included in this PR — documented in PRDCT-351 comment):

  • Whether to document source_url conditional visibility (only shown when SSH disabled)
  • Whether to document that private key accepts both base64 AND raw PEM
  • Whether to clarify service_name is a URL path segment
  • Which K2 conditions link anchor to use (original anchors no longer exist at new URL)"

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

- Fix K2 SSH field names to match configSchema UI titles
  (Remote Address → K2 API Source Address, Remote Port → K2 API Port)
- Add missing #private_key_password field to K2 SSH docs
- Fix broken K2 documentation link (k2gaia/02 → k2gaia/12)
- Convert 3 absolute help.keboola.com links to root-relative
- Fix Source Url → Source URL capitalization
- Align ERP index title with siblings (ERP → ERP Data Source Connectors)
- Add missing redirect_from to ERP index

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@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 19, 2026

Copy link
Copy Markdown

PRDCT-351

@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jun 19, 2026 2:28pm

Request Review

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.

1 participant