partner integration docs v0#6262
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
|
Docs PR opened: ClickHouse/mintlify-docs-dev#46 Added a four-page Partner program section guiding partners on building, testing, and documenting ClickHouse integrations. |
alexfrancoeur
left a comment
alexfrancoeur
left a comment
There was a problem hiding this comment.
This is amazing, thank you @mshustov 🙏 🙏 🙏 🙏
I dropped in comments that are more around positioning (integration development vs. partner focused) and some others around identification, etc. I think we can probably talk through these things, come to an agreement, and I'm happy to help update the docs based on where we land.
|
|
||
| ## Sandbox and trial access {#sandbox-and-trial-access} | ||
|
|
||
| [ClickHouse Cloud](https://clickhouse.com/cloud) offers a free trial for development and integration validation. Partners enrolled in the formal program receive additional development credits; details will be available in the partner portal. |
There was a problem hiding this comment.
@Amehla we should clarify what's available in the partner portal and how much we should lean on this narrative in these docs. My thinking is that we make this more generic vs. pointing to the partner portal. For this one specifically, I think it's fine if we say something like -- "if you are a House Mate and partner, you can get credits in the partner portal"
| | Partner integrations | Built or maintained, and supported by, third-party software vendors | | ||
| | Community integrations | Built or maintained and supported by community members. No direct support is available besides the public GitHub repositories and community Slack channels | | ||
|
|
||
| :::tip Building a partner integration? |
There was a problem hiding this comment.
@Amehla we'll need the stubbed link for the partner portal and sign up page
| These guides orient you if you build a product that connects to ClickHouse. They cover the integration surface, how to validate your connector, and how to publish documentation on this site. | ||
|
|
||
| :::note Partner portal | ||
| A dedicated [partner portal](https://clickhouse.com/partners) is launching soon. Until then, use these pages to get started. [Sign up](https://clickhouse.com/partners) when the portal is available to register your integration. |
There was a problem hiding this comment.
I think we should just act like it's available today and publish this when it's live. It's only a few days away, but let's confirm with @Amehla
…s.md Co-authored-by: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
Co-authored-by: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
…on process and improve guidance for building integrations.
Keep published partner portal wording with bracketed tip/note admonition syntax from main. Co-authored-by: Cursor <cursoragent@cursor.com>
3 participants
Summary
Adds v0 Partner program documentation for external partners building ClickHouse integrations. This is interim onboarding content until a dedicated partner portal launches at the upcoming event.
New section at /integrations/partners with four pages:
Navigation: new Partner program sidebar category under Integrations; tip callout on the Integrations landing page pointing partners to the guides
Note
Low Risk
Documentation and sidebar navigation only; no runtime, auth, or application code changes.
Overview
Adds a new Integration development partner onboarding section under
/integrations/integration-development, with an overview plus three guides: building (ClickPipes vs language clients, consumption,User-Agent, trials), testing (Cloud + OSS matrix, types/scale/auth, example datasets), and documenting (required page sections and a PR skeleton forclickhouse-docs).The Integrations landing page gets a tip callout pointing builders to these guides and the partner portal. Navigation wires the section in
sidebars.jsand_category_.ymlas a collapsible category under Integrations.Reviewed by Cursor Bugbot for commit 1c98956. Bugbot is set up for automated code reviews on this repo. Configure here.