Repository navigation
PRDCT-695: add help pages for 8 connectors that have none - #1183
Conversation
Jiří Soukup's ask (12.10): MixPanel, LangSmith Traces, mPOHODA (source and destination), POHODA mServer (source and destination), UKG HR and SuiteProjects Pro had no page on help.keboola.com and their documentationUrl points at private READMEs. One reference page per component, built from each component's registry copy and config schema; a new writers/erp category with its index; nav entries and category index lines. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Type markers after the ledes, search keywords for the names readers use (OpenAir, HRSD, Stormware), counterpart links on the four POHODA pages, the mPOHODA agenda list matched to the schema enum, SuiteProjects load type and custom-field labels taken from the schema, limits moved to the end of reference pages, and the new writers/erp index says which POHODA connector fits which setup. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Bare links in the ERP indexes to match their neighbours, Lookback and date window formats on the SuiteProjects Pro page, and a Limits section on UKG HR. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
Someone is attempting to deploy a commit to the Keboola Engineering Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The first fork deployment errored seconds after it was authorized; the branch builds clean from a fresh clone. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: needs_human (risk 3/5) · profile connection-docs
Needs human: an unresolved VERIFY marker on an added line blocks auto-approve under content gate 3.
Concerns:
src/content/docs/components/extractors/other/langsmith-traces/index.md: Unresolved VERIFY(Jiří Soukup) on added line 54; output table names/PKs unverified.src/content/docs/components/extractors/marketing-sales/mixpanel/index.md: Casing drift: 'MixPanel' and 'Mixpanel' both used for same product.
Suggested reviewers: @keboola/docs
Connection and row forms of each connector, captured from the product UI with empty sample configurations (deleted afterwards), cropped to the form card, no account details in frame. SuiteProjects Pro names the Load date fields button the shot shows. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Jiří's second ask (12 Oct): Azure Cost Management gets a section on the Service Principal connector (Tenant ID, Username, Password from the schema; the Azure role is left to verify), Google BigQuery gets a paragraph on the Avro files variant written from his summary, since that component is in no stack registry yet. Both pages gain a description. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
Thanks, the pages look good. I checked the fields on all ten pages against the component schemas, and the Azure, BigQuery and LangSmith parts against the source code. Answers to the three VERIFY markers: 1. Azure Cost Management Service Principal: Azure role
2. Google BigQuery avro files: name, id, one query = one file
3. LangSmith Traces: output tables
|
Jiri-Soukup
left a comment
There was a problem hiding this comment.
I read all eight new pages and the two changed ones in full, and checked every field, default, enum and limit against the component schemas. They match, and the screenshots contain no data. One change is needed before merge, plus three smaller points.
Needs a change
- BigQuery avro files (
components/extractors/database/bigquery/): please drop "Use it for results too large for a table". The Avro variant exports each result to a single file, and BigQuery can write at most 1 GB to a single file, so large results fail rather than work better. Details in my comment above.
Please also update
- LangSmith Traces, Output: the deployed version writes
runs(primary keyid) andlangsmith_feedback(primary keysidandrun_id), both incremental. You can name them and drop the VERIFY. - Azure Cost Management Service Principal: keep the general "read access to Cost Management" wording and the VERIFY, as explained in my comment.
Suggestions, not blocking
- POHODA mServer (both pages): the Prerequisites ask for an mServer reachable from Keboola over plain HTTP, so credentials and data travel unencrypted. Consider adding a line recommending that access be limited to Keboola's IP addresses, or that mServer sit behind a VPN.
- MixPanel: the page says "name-value-pair table" in the intro and "key-value pair table" under Raw data export. Pick one term.
I'll approve once 1–3 are in.
- BigQuery avro files: name the connector id, drop "for results too large for a table", and state the 1 GB single-file export limit instead. - LangSmith Traces: name the output tables (runs, langsmith_feedback) with their primary keys; VERIFY resolved by the reviewer. - Azure Service Principal: keep the general read-access wording, VERIFY text updated with what the reviewer found. - POHODA mServer (both): recommend allowing only Keboola's IP addresses or a VPN, since mServer speaks plain HTTP. - MixPanel: one term, "name-value pair table". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Thanks for going through all ten pages. Everything is in e3244ad:
About whether the Avro variant should be documented at all, since it isn't in |
- mPOHODA writer: the row form has no table input mapping (the component lacks genericDockerUI-tableInput, checked live), so the page no longer tells readers to fill one; a caution says so and a VERIFY asks for the flag. - BigQuery: description moved next to title, so a merge with keboola#993 conflicts instead of leaving two description keys; page typed How-to. - POHODA mServer (both): example URL is a reachable host, not 192.168.x.x; the VPN suggestion is dropped because the connector has no tunnel and a VPN-only mServer is unreachable. - MixPanel: VERIFY asks which primary key incremental load uses. - Azure: page typed How-to, OAuth variant named as in the catalogue, the unsourced "keeps working when that person leaves" removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Jiří Soukup (@Jiri-Soukup) found eight connectors with no page on help.keboola.com while auditing component links in the developer portal on 12 Oct. Their
documentationUrlpoints at private GitHub READMEs, so the Documentation link in the UI is dead for customers. This PR gives each one a reference page. Linear: PRDCT-695.The pages
kds-team.ex-mixpanelcomponents/extractors/marketing-sales/mixpanel/keboola.ex-langsmith-tracescomponents/extractors/other/langsmith-traces/keboola.ex-mpohodacomponents/extractors/erp/mpohoda/keboola.ex-pohoda-mservercomponents/extractors/erp/pohoda-mserver/keboola.ex-suiteprojects-procomponents/extractors/erp/suiteprojects-pro/keboola.ukg-hrcomponents/extractors/other/ukg-hr/keboola.wr-mpohodacomponents/writers/erp/mpohoda/keboola.wr-pohoda-mservercomponents/writers/erp/pohoda-mserver/writers/erpwith its index and a nav group between Database and Storage, for the two POHODA destination connectors. The writers hub lists it too.search_keywordscarry the names people search for (OpenAir, HRSD, Stormware).Where the facts come from
Only each component's own registry copy (
/v2/storage: longDescription, configurationDescription, config and row schema), run through thecomponent-copyskill's facts script first. Where the owner's prose and the schema disagree, the schema wins:Screenshots
Each page shows the connection form and, for row-based connectors, the row form, captured from the product UI with empty sample configurations (deleted afterwards) and cropped to the form card.
Two variants on existing pages (Jiří's second ask)
components/extractors/other/azure-cost/: new section on the Azure Cost Management Service Principal connector (keboola.ex-azure-cost-management-sp): when to use it, the Subscription ID, Tenant ID, Username and Password fields from its schema, Username and Password being the application (client) ID and client secret. The Azure role the principal needs is aVERIFY(Jiří Soukup).components/extractors/database/bigquery/: new paragraph on the Google BigQuery avro files variant, written from Jiří's summary of the developer-portal description, because that component is in no stack's/v2/storageon 12 Oct. Its name, id and one-query-one-file behaviour are aVERIFY(Jiří Soukup).Open question
VERIFY(Jiří Soukup)comment that the build strips. @Jiri-Soukup, do you know them, or who ownskeboola-rnd/langsmith-trace-extractor?Not in this PR
Repointing each component's
documentationUrlto its new page is a change in the component repos (PRDCT-650); the portal picks it up on the next semver tag.Checks
npm run buildclean (383 pages); link and redirect check 0 blockers;audit-phase20 broken links, 0 missing images; Diátaxis script and agent PASS on all nine pages; fact-checker no CRITICAL findings, its MAJOR and MINOR items fixed; checker agent PASS. Preview checked for the sidebar group and table wrapping.🤖 Generated with Claude Code