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.
| @@ -0,0 +1,7 @@ | |||
| position: 500 | |||
| label: 'Partner program' | |||
There was a problem hiding this comment.
| label: 'Partner program' | |
| label: 'Integration development' |
Thoughts on trying to generalize here? The decision here would impact link id, some text, keywords and sections. Happy to suggest those changes if we're on the same page
| sidebar_label: 'Building integrations' | ||
| sidebar_position: 2 | ||
| description: 'Orientation for partners on ingestion, consumption, wire protocols, and client conventions.' | ||
| keywords: ['partner', 'ingestion', 'consumption', 'ClickPipes', 'language clients', 'user-agent'] |
There was a problem hiding this comment.
| keywords: ['partner', 'ingestion', 'consumption', 'ClickPipes', 'language clients', 'user-agent'] | |
| keywords: ['partner', 'ingestion', 'consumption', 'ClickPipes', 'language clients', 'user-agent', 'integration'] |
|
|
||
| Pick a path, prototype against a [ClickHouse Cloud trial](https://clickhouse.com/cloud), and register your integration through the partner portal when it is available. | ||
|
|
||
| ## User-agent string convention {#user-agent-string-convention} |
There was a problem hiding this comment.
We could probably reference this for JDBC specifically too since it's so commonly used: https://clickhouse.com/docs/integrations/language-clients/java/jdbc#client-identification
|
|
||
| ## 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"
|
|
||
| ## Where docs live {#where-docs-live} | ||
|
|
||
| - **Repository:** [`ClickHouse/clickhouse-docs`](https://github.com/ClickHouse/clickhouse-docs) |
There was a problem hiding this comment.
open question -- do we want partner docs in our docs? I initially assumed we'd be pushing docs back to the partner and referencing them from our integration pages and drill downs. @Amehla let us know how you were thinking about it. Either would work, these are OSS. It definitely gives us more CH eyes on them on an opportunity to validate the changes as @mshustov suggests below.
|
|
||
| ## Required sections {#required-sections} | ||
|
|
||
| Every partner integration page should cover the following, ideally in this order: |
There was a problem hiding this comment.
@mshustov should we enforce self-categorization?
| Cover both deployment modes. Most customers run one or the other, and behavior differs in places (auth, networking, available features). | ||
|
|
||
| - **ClickHouse Cloud:** sign up for a [free trial](https://clickhouse.com/cloud). No credit card is required for the development tier | ||
| - **Self-hosted (OSS):** use the latest stable release from [GitHub releases](https://github.com/ClickHouse/ClickHouse/releases). The [install guide](/install) is the fastest path to a local instance with Docker |
There was a problem hiding this comment.
| - **Self-hosted (OSS):** use the latest stable release from [GitHub releases](https://github.com/ClickHouse/ClickHouse/releases). The [install guide](/install) is the fastest path to a local instance with Docker | |
| - **Self-hosted (Open Source):** use the latest stable release from [GitHub releases](https://github.com/ClickHouse/ClickHouse/releases). The [install guide](/install) is the fastest path to a local instance with Docker |
| | 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
2 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