Skip to content

Commit

Permalink
📚 Docs: Add Support Level, remove release stage (airbytehq#30501)
Browse files Browse the repository at this point in the history
Co-authored-by: Lake Mossman <[email protected]>
  • Loading branch information
bnchrch and lmossman authored Sep 18, 2023
1 parent 9751703 commit 26fe788
Show file tree
Hide file tree
Showing 9 changed files with 60 additions and 62 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Developer updates will be announced via our #help-connector-development Slack ch
:::

:::note
The low-code framework is in [beta](https://docs.airbyte.com/project-overview/product-release-stages/#beta), which means that while it will be backwards compatible, it’s still in active development. Share feedback and requests with us on our [Slack channel](https://slack.airbyte.com/) or email us at [[email protected]](mailto:[email protected])
The low-code framework is in **beta**, which means that while it will be backwards compatible, it’s still in active development. Share feedback and requests with us on our [Slack channel](https://slack.airbyte.com/) or email us at [[email protected]](mailto:[email protected])
:::

## Why low-code?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

:warning: This framework is in [alpha](https://docs.airbyte.com/project-overview/product-release-stages/#alpha). It is still in active development and may include backward-incompatible changes. Please share feedback and requests directly with us at [email protected] :warning:
:warning: This framework is in **alpha**. It is still in active development and may include backward-incompatible changes. Please share feedback and requests directly with us at [email protected] :warning:

## Summary

Expand Down
12 changes: 5 additions & 7 deletions docs/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@ import ConnectorRegistry from '@site/src/components/ConnectorRegistry';

# Connector Catalog

## Connector Release Stages
## Connector Support Levels

Airbyte uses a grading system for connectors to help you understand what to expect from a connector:
Airbyte uses a two tiered system for connectors to help you understand what to expect from a connector:

**Generally Available**: A generally available connector has been deemed ready for use in a production environment and is officially supported by Airbyte. Its documentation is considered sufficient to support widespread adoption.
**Certified**: A certified connector is actively maintained and supported by the Airbyte team and maintains a high quality bar. It is production ready.

**Beta**: A beta connector is considered stable with no backwards incompatible changes but has not been validated by a broader group of users. We expect to find and fix a few issues and bugs in the release before it’s ready for GA.
**Community**: A community connector is maintained by the Airbyte community until it becomes Certified. Airbyte has over 800 code contributors and 15,000 people in the Slack community to help. The Airbyte team is continually certifying Community connectors as usage grows. As these connectors are not maintained by Airbyte, we do not offer support SLAs around them, and we encourage caution when using them in production.

**Alpha**: An alpha connector signifies a connector under development and helps Airbyte gather early feedback and issues reported by early adopters. We strongly discourage using alpha releases for production use cases and do not offer Cloud Support SLAs around these products, features, or connectors.

For more information about the grading system, see [Product Release Stages](https://docs.airbyte.com/project-overview/product-release-stages)
For more information about the system, see [Product Support Levels](https://docs.airbyte.com/project-overview/product-support-levels)

_[View the connector registries in full](https://connectors.airbyte.com/files/generated_reports/connector_registry_report.html)_

Expand Down
6 changes: 3 additions & 3 deletions docs/operator-guides/contact-support.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Airbyte Support

Hold up! Have you looked at [our docs](https://docs.airbyte.com/) yet? We recommend searching the wealth of knowledge in our documentation as many times the answer you are looking for is there!
Hold up! Have you looked at [our docs](https://docs.airbyte.com/) yet? We recommend searching the wealth of knowledge in our documentation as many times the answer you are looking for is there!

## Airbyte Open Source Support

Expand All @@ -26,7 +26,7 @@ If you have questions about connector setup, error resolution, or want to report

If you couldn't find the information you need in our docs or Help Center, open a ticket within the Airbyte Cloud platform by selecting the "Support" icon in the lower left navigation bar. Alternatively, you can submit a ticket through our [Help Center](https://support.airbyte.com/hc/en-us) by completing an Airbyte Cloud Support Request.

If you're unsure about the supported connectors, refer to our [connector catalog](https://docs.airbyte.com/integrations/) & [release phases](https://docs.airbyte.com/project-overview/product-release-stages/).
If you're unsure about the supported connectors, refer to our [Connector Catalog](https://docs.airbyte.com/integrations/) & [Connector Support Levels](https://docs.airbyte.com/project-overview/product-support-levels/).

For account or credit-related inquiries, contact our [sales team](https://airbyte.com/talk-to-sales).

Expand All @@ -48,7 +48,7 @@ Submitting a Pull Request for review?
* If you are submitting a Platform PR we accept Platform PRs in the areas below:
* Helm
* Environment variable configurations
* Bug Fixes
* Bug Fixes
* Security version bumps
* **If outside these areas, please open up an issue to help the team understand the need and if we are able to consider a PR**

Expand Down
39 changes: 0 additions & 39 deletions docs/project-overview/product-release-stages.md

This file was deleted.

39 changes: 39 additions & 0 deletions docs/project-overview/product-support-levels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Connector Support Levels

The following table describes the support levels of Airbyte connectors.

| | Certified | Custom | Community |
| --------------------------------- | -------------------------- | -------------------------- | ---------------------- |
| **Availability** | Available to all users | Available to all users | Available to all users |
| **Support: Cloud** | Supported* | Supported** | No Support |
| **Support: Powered by Airbyte** | Supported* | Supported** | No Support |
| **Support: Self-Managed Enterprise** | Supported* | Supported** | No Support |
| **Support: Community (OSS)** | Slack Support only | Slack Support only | No Support |
| **Who builds them?** | Either the community or the Airbyte team. | Anyone can build custom connectors. We recommend using our [Connector Builder](https://docs.airbyte.com/connector-development/connector-builder-ui/overview) or [Low-code CDK](https://docs.airbyte.com/connector-development/config-based/low-code-cdk-overview). | Typically they are built by the community. The Airbyte team may upgrade them to Certified at any time. |
| **Who maintains them?** | The Airbyte team | Users | Users |
| **Production Readiness** | Guaranteed by Airbyte | Not guaranteed | Not guaranteed |

\*For Certified connectors, Official Support SLAs are only available to customers with Premium Support included in their contract. Otherwise, please use our support portal and we will address your issues as soon as possible.

\*\*For Custom connectors, Official Support SLAs are only available to customers with Premium Support included in their contract. This support is provided with best efforts, and maintenance/upgrades are owned by the customer.

## Certified

A **Certified** connector is actively maintained and supported by the Airbyte team and maintains a high quality bar. It is production ready.

### What you should know about Certified connectors:

- Certified connectors are available to all users.
- These connectors have been tested and vetted in order to be certified and are production ready.
- Certified connectors should go through minimal breaking change but in the event an upgrade is needed users will be given an adequate upgrade window.

## Community

A **Community** connector is maintained by the Airbyte community until it becomes Certified. Airbyte has over 800 code contributors and 15,000 people in the Slack community to help. The Airbyte team is continually certifying Community connectors as usage grows. As these connectors are not maintained by Airbyte, we do not offer support SLAs around them, and we encourage caution when using them in production.

### What you should know about Community connectors:

- Community connectors are available to all users.
- Community connectors may be upgraded to Certified at any time, and we will notify users of these upgrades via our Slack Community and in our Connector Catalog.
- Community connectors might not be feature-complete (features planned for release are under development or not prioritized) and may include backward-incompatible/breaking API changes with no or short notice.
- Community connectors have no Support SLAs.
4 changes: 3 additions & 1 deletion docusaurus/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
to: /understanding-airbyte/airbyte-protocol
- from: /integrations/sources/appstore
to: /integrations/sources/appstore-singer
- from:
- from:
- /project-overview/security
- /operator-guides/securing-airbyte
to: /operator-guides/security
Expand All @@ -31,3 +31,5 @@
to: /cloud/managing-airbyte-cloud/manage-connection-state
- from: /cloud/managing-airbyte-cloud/edit-stream-configuration
to: /cloud/managing-airbyte-cloud/configuring-connections
- from: /project-overview/product-release-stages
to: /project-overview/product-support-levels
2 changes: 1 addition & 1 deletion docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ module.exports = {
label: "Roadmap",
href: "https://go.airbyte.com/roadmap",
},
"project-overview/product-release-stages",
"project-overview/product-support-levels",
"project-overview/slack-code-of-conduct",
"project-overview/code-of-conduct",
{
Expand Down
16 changes: 7 additions & 9 deletions docusaurus/src/components/ConnectorRegistry.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,11 @@ async function fetchCatalog(url, setter) {
Sorts connectors by release stage and then name
*/
function connectorSort(a, b) {
if (a.releaseStage_oss !== b.releaseStage_oss) {
if (a.releaseStage_oss === "generally_available") return -3;
if (b.releaseStage_oss === "generally_available") return 3;
if (a.releaseStage_oss === "beta") return -2;
if (b.releaseStage_oss === "beta") return 2;
if (a.releaseStage_oss === "alpha") return -1;
if (b.releaseStage_oss === "alpha") return 1;
if (a.supportLevel_oss !== b.supportLevel_oss) {
if (a.supportLevel_oss === "certified") return -2;
if (b.supportLevel_oss === "certified") return 2;
if (a.supportLevel_oss === "community") return -1;
if (b.supportLevel_oss === "community") return 1;
}

if (a.name_oss < b.name_oss) return -1;
Expand Down Expand Up @@ -50,7 +48,7 @@ export default function ConnectorRegistry({ type }) {
<th>Connector Name</th>
<th>Icon</th>
<th>Links</th>
<th>Release Stage</th>
<th>Support Level</th>
<th>OSS</th>
<th>Cloud</th>
<th>Docker Image</th>
Expand Down Expand Up @@ -82,7 +80,7 @@ export default function ConnectorRegistry({ type }) {
<a href={connector.issue_url}>🐛</a>
</td>
<td>
<small>{connector.releaseStage_oss}</small>
<small>{connector.supportLevel_oss}</small>
</td>
<td>{connector.is_oss ? "✅" : "❌"}</td>
<td>{connector.is_cloud ? "✅" : "❌"}</td>
Expand Down

0 comments on commit 26fe788

Please sign in to comment.