From 26fe7886ebac10766c541457043dc115fc5e726d Mon Sep 17 00:00:00 2001 From: Ben Church Date: Mon, 18 Sep 2023 08:55:13 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20=20Docs:=20Add=20Support=20Level?= =?UTF-8?q?,=20remove=20release=20stage=20(#30501)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Lake Mossman --- .../config-based/low-code-cdk-overview.md | 2 +- .../tutorial/0-getting-started.md | 2 +- docs/integrations/README.md | 12 +++--- docs/operator-guides/contact-support.md | 6 +-- .../product-release-stages.md | 39 ------------------- .../product-support-levels.md | 39 +++++++++++++++++++ docusaurus/redirects.yml | 4 +- docusaurus/sidebars.js | 2 +- .../src/components/ConnectorRegistry.jsx | 16 ++++---- 9 files changed, 60 insertions(+), 62 deletions(-) delete mode 100644 docs/project-overview/product-release-stages.md create mode 100644 docs/project-overview/product-support-levels.md diff --git a/docs/connector-development/config-based/low-code-cdk-overview.md b/docs/connector-development/config-based/low-code-cdk-overview.md index c612968e7a215..58f74eb8d8d8a 100644 --- a/docs/connector-development/config-based/low-code-cdk-overview.md +++ b/docs/connector-development/config-based/low-code-cdk-overview.md @@ -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 [feedback@airbyte.io](mailto:feedback@airbyte.io) +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 [feedback@airbyte.io](mailto:feedback@airbyte.io) ::: ## Why low-code? diff --git a/docs/connector-development/config-based/tutorial/0-getting-started.md b/docs/connector-development/config-based/tutorial/0-getting-started.md index 72cf4cab7df01..e1a7b0fd64c9c 100644 --- a/docs/connector-development/config-based/tutorial/0-getting-started.md +++ b/docs/connector-development/config-based/tutorial/0-getting-started.md @@ -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 feedback@airbyte.io :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 feedback@airbyte.io :warning: ## Summary diff --git a/docs/integrations/README.md b/docs/integrations/README.md index 01da3eae1fb21..fef3f532394df 100644 --- a/docs/integrations/README.md +++ b/docs/integrations/README.md @@ -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)_ diff --git a/docs/operator-guides/contact-support.md b/docs/operator-guides/contact-support.md index 659a35e0b8541..49965d7701a2c 100644 --- a/docs/operator-guides/contact-support.md +++ b/docs/operator-guides/contact-support.md @@ -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 @@ -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). @@ -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** diff --git a/docs/project-overview/product-release-stages.md b/docs/project-overview/product-release-stages.md deleted file mode 100644 index 5eebc97556e35..0000000000000 --- a/docs/project-overview/product-release-stages.md +++ /dev/null @@ -1,39 +0,0 @@ -# Product Release Stages - -The following release stages describe the lifecycle of an Airbyte product, feature, or connector. - -| Expectations | Alpha | Beta | General Availability (GA)| -|:-------------|:------|:-----|:-------------------------| -| Customer Availability | Alpha features and products may have limited availability (by invitation only)

Alpha connectors are available to all users | Beta features and products may have limited availability (by invitation only)

Beta connectors are available to all users | Available to all users | -|Support | Cloud: No Support SLAs

Open-source: Community Slack Support | Cloud: Official Beta Support SLA

Open-source: Community Slack Support | Cloud: Official GA Support SLA

Open-source: Community Slack Support | -| Production Readiness | No | Yes (with caveats) | Yes | - -## Alpha -An alpha release signifies a product, feature, or 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. - -### What you should know about an alpha release - -- An alpha release might not be feature-complete (features planned for the release are under development) and may include backward-incompatible/breaking API changes. -- Access for alpha features and products may not be enabled for all Airbyte users by default. Depending on the feature, you may enable the feature either from the Airbyte UI or by contacting Airbyte Support. Alpha connectors are available to all users. -- Alpha releases may be announced via email, in the Airbyte UI, and/or through certain pages of the Airbyte docs. - -## Beta -A beta release is considered stable and reliable 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. - -### What you should know about a beta release - -- A beta release is generally feature-complete (features planned for the release have been mostly implemented) and does not include backward-incompatible/breaking API changes. -- Access may be enabled for all Airbyte users by default. Depending on the feature, you may enable the feature either from the Airbyte UI or by contacting Airbyte Support. Beta connectors are available to all users. -- Beta releases may be announced via email, in the Airbyte UI, and/or through certain pages of the Airbyte docs. - -## General availability (GA) -A generally available release 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. - -### What you should know about a GA release - -- A GA release is feature-complete (features planned for the release have been fully implemented) and does not include backward-incompatible/breaking API changes. -- Access is enabled for all Airbyte users by default. Depending on the feature, you may enable the feature either from the Airbyte UI or by contacting Airbyte Support. -- GA releases may be announced via email, in the Airbyte UI, and/or through certain pages of the Airbyte docs. - -## Deprecated -A deprecated feature, product, or connector is no longer officially supported by Airbyte. It might continue to work for a period of time but Airbyte recommends that you migrate away from and avoid relying on deprecated releases. diff --git a/docs/project-overview/product-support-levels.md b/docs/project-overview/product-support-levels.md new file mode 100644 index 0000000000000..47e533d90f406 --- /dev/null +++ b/docs/project-overview/product-support-levels.md @@ -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. diff --git a/docusaurus/redirects.yml b/docusaurus/redirects.yml index 9c58e209d60a5..1014d9a7758c5 100644 --- a/docusaurus/redirects.yml +++ b/docusaurus/redirects.yml @@ -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 @@ -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 diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index c7c4725541162..447c5ef35be85 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -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", { diff --git a/docusaurus/src/components/ConnectorRegistry.jsx b/docusaurus/src/components/ConnectorRegistry.jsx index b9b4900d6092d..3b81708e3192a 100644 --- a/docusaurus/src/components/ConnectorRegistry.jsx +++ b/docusaurus/src/components/ConnectorRegistry.jsx @@ -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; @@ -50,7 +48,7 @@ export default function ConnectorRegistry({ type }) { Connector Name Icon Links - Release Stage + Support Level OSS Cloud Docker Image @@ -82,7 +80,7 @@ export default function ConnectorRegistry({ type }) { 🐛 - {connector.releaseStage_oss} + {connector.supportLevel_oss} {connector.is_oss ? "✅" : "❌"} {connector.is_cloud ? "✅" : "❌"}