-
Notifications
You must be signed in to change notification settings - Fork 947
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
introduce "trusted" tier for adapters (#3758)
## What are you changing in this pull request and why? Introducing Trusted adapters. ## Pages Changed ### Supported Data Platforms [preview](https://deploy-preview-3758--docs-getdbt-com.netlify.app/docs/supported-data-platforms) - Added bullet point about "Trusted adapters" - Added Trusted adapter cards below the verified adapter cards ### Trusted Adapters [preview](https://deploy-preview-3758--docs-getdbt-com.netlify.app/docs/trusted-adapters) - brand new page that gives overview - links out to a new adapter dev guide ### Building a Trusted Adapter [preview](https://deploy-preview-3758--docs-getdbt-com.netlify.app/guides/dbt-ecosystem/adapter-development/8-building-a-trusted-adapter) - details what Trusted adapter means - enumerates the relevant guidelines - explains how to become Trusted ### New Issue Template [Link to `.yaml`](https://github.com/dbt-labs/docs.getdbt.com/pull/3758/files#diff-ef4a0e442faae77613880dfc0527a87b5f0444e3512597c3d622eaed7ce5ffaf) (there's no way to preview this AFAICT) This serves as both a webform and also a "contract" ### Other changes - Make the cards view for Verified and Trusted adapters into snippets for re-usability - add Verified Adapters overview page to sidebar - remove outdated reference on "Connect Adapters" page - small cleanups ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [ ] internal stakeholders approve Adding new pages (delete if not applicable): - [x] Add page to `website/sidebars.js` - [ ] Provide a unique filename for the new page
- Loading branch information
Showing
10 changed files
with
285 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| name: Add adapter to Trusted list | ||
| description: > | ||
| For adapter maintainers who wish to have theirs added to the list of [Trusted adapters](https://docs.getdbt.com/docs/trusted-adapters) | ||
| labels: ["adapter maintainers"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| We're excited that you'd like to support your adapter formally as "Trusted"! This template will ensure that you are aware of the process and the guidelines. Additionally, that you can vouch that your adapter currently meets the standards of a Trusted adapter | ||
| - type: input | ||
| id: adapter-repo | ||
| attributes: | ||
| label: Link to adapter repo | ||
| description: Please link to the GitHub repo | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: contact | ||
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you? | ||
| placeholder: your preferred email and/or dbt Slack handle | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: author_type | ||
| attributes: | ||
| label: Which of these best describes you? | ||
| options: | ||
| - label: I am a dbt Community member | ||
| - label: I work for the vendor on top of which the dbt adapter functions | ||
|
|
||
| - type: checkboxes | ||
| id: read-program-guide | ||
| attributes: | ||
| label: Please agree to the each of the following | ||
| options: | ||
| - label: I am a maintainer of the adapter being submited for Trusted status | ||
| - label: I have read both the [Trusted adapters](https://docs.getdbt.com/docs/trusted-adapters) and [Building a Trusted Adapter](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/8-building-a-trusted-adapter) pages. | ||
| - label: I believe that the adapter currently meets the expectations given above | ||
| - label: I will ensure this adapter stays in compliance with the guidelines | ||
| - label: I understand that dbt Labs reserves the right to remove an adapter from the trusted adapter list at any time, should any of the below guidelines not be met | ||
| validations: | ||
| required: true | ||
|
|
||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: "Trusted adapters" | ||
| id: "trusted-adapters" | ||
| --- | ||
|
|
||
| Trusted adapters are adapters not maintained by dbt Labs, that we feel comfortable recommending to users for use in production. | ||
|
|
||
| Free and open-source tools for the data professional are increasingly abundant. This is by-and-large a *good thing*, however it requires due dilligence that wasn't required in a paid-license, closed-source software world. As a user, there are questions to answer important before taking a dependency on an open-source project. The trusted adapter designation is meant to streamline this process for end users. | ||
|
|
||
| <details><summary>Considerations for depending on an open-source project</summary> | ||
|
|
||
| 1. Does it work? | ||
| 2. Does anyone "own" the code, or is anyone liable for ensuring it works? | ||
| 3. Do bugs get fixed quickly? | ||
| 4. Does it stay up-to-date with new Core features? | ||
| 5. Is the usage substantial enough to self-sustain? | ||
| pendency on this library? | ||
|
|
||
| </details> | ||
|
|
||
| ### Trusted adapter specifications | ||
|
|
||
| See [Building a Trusted Adapter](/guides/dbt-ecosystem/adapter-development/8-building-a-trusted-adapter) for more information, particularly if you are an adapter maintainer considering having your adapter be added to the trusted list. | ||
|
|
||
| ### Trusted vs Verified | ||
|
|
||
| The Verification program exists to highlight adapters that meets both of the following criteria: | ||
|
|
||
| - the guidelines given in the Trusted program, | ||
| - formal agreements required for integration with dbt Cloud | ||
|
|
||
| For more information on the Verified Adapter program, reach out the [dbt Labs partnerships team](mailto:[email protected]) | ||
|
|
||
| ### Trusted adapters | ||
|
|
||
| The following are **Trusted adapters** ✓ you can connect to in dbt Core: | ||
|
|
||
| import AdaptersTrusted from '/snippets/_adapters-trusted.md'; | ||
|
|
||
| <AdaptersTrusted /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.