Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove deprecated Builder compatibility guide from docs #54145

Merged
merged 2 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/connector-development/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you need support along the way, visit the [Slack channel](https://airbytehq.s

### Process overview

1. **Pick the technology and build**. The first step in creating a new connector is to choose the tools you’ll use to build it. For _most_ cases, you should start in Connector Builder. To understand which approach you should take, review the [compatibility guide](./connector-builder-ui/connector-builder-compatibility.md).
1. **Pick the technology and build**. The first step in creating a new connector is to choose the tools you’ll use to build it. For _most_ cases, you should start in Connector Builder.
2. **Publish as a custom connector**.After building and testing your connector, you’ll need to publish it. This makes it available in your workspace. At that point, you can use the connector you’ve built to move some data!
3. **Contribute back to Airbyte**. If you want to contribute what you’ve built to the Airbyte Cloud and OSS connector catalog, follow the steps provided in the [contribution guide for submitting new connectors](../contributing-to-airbyte/submit-new-connector.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Depending on how the refresh endpoint is implemented exactly, additional configu
- **Token expire property date format** - if not specified, the expiry property is interpreted as the number of seconds the access token will be valid
- **Access token property name** - the name of the property in the response that contains the access token to do requests. If not specified, it's set to `access_token`

If the API uses other grant types like PKCE are required, it's not possible to use the connector builder with OAuth authentication - check out the [compatibility guide](/connector-development/connector-builder-ui/connector-builder-compatibility#oauth) for more information.
If the API uses other grant types (like PKCE), it's not possible to use the connector builder with OAuth authentication.

Keep in mind that the OAuth authentication method does not implement a single-click authentication experience for the end user configuring the connector - it will still be necessary to obtain client id, client secret and refresh token from the API and manually enter them into the configuration form.

Expand Down

This file was deleted.

5 changes: 2 additions & 3 deletions docs/connector-development/connector-builder-ui/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ Connector Builder offers the most straightforward method for building, contribut

## When should I use Connector Builder?

First, check if the API you want to use has an available connector in the [catalog](../../integrations). If you find it there, you can use it as is. If you need to update an existing connector, see the guide for updates.

You can build a connector with the Connector Builder if you want to connect to an HTTP API that returns a collection of records as JSON and has fixed endpoints. For more detailed information on requirements, refer to the [compatibility guide](./connector-builder-compatibility.md).
First, check if the API you want to use has an available connector in the [catalog](../../integrations). If you find it there, you can use it as is.
If the connector you're looking for doesn't already exist and you'd like to try creating your own implementation, the Connector Builder should be your first destination.

## Getting started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,4 +204,4 @@ This tutorial didn't go into depth about all features that can be used in the co
* [Partitioning](/connector-development/connector-builder-ui/partitioning/)
* [Error handling](/connector-development/connector-builder-ui/error-handling/)

Not every possible API can be consumed by connectors configured in the connector builder. The [compatibility guide](/connector-development/connector-builder-ui/connector-builder-compatibility#oauth) can help determining whether another technology should be used to integrate an API with the Airbyte platform.
Not every possible API can be consumed by connectors configured in the connector builder. If you need more flexibility, consider using the [Low Code CDK](/connector-development/config-based/low-code-cdk-overview) or the [Python CDK](/connector-development/cdk-python/) to build a connector with more advanced features.
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ This tutorial will walk you through the creation of a custom Airbyte connector i
Python CDK. It assumes you're already familiar with Airbyte concepts and you've already built a
connector using the [Connector Builder](../../connector-builder-ui/tutorial.mdx).

The Python CDK should be used to implement connectors that require features that are not yet
available in the Connector Builder or in the low-code framework. You can use the
[Connector Builder compatibility guide](../../connector-builder-ui/connector-builder-compatibility.md)
to know whether it is suitable for your needs.
:::tip
We highly recommend using the Connector Builder for most use cases;
while the Python CDK is more flexible, it requires a deeper understanding of underlying connector logic,
as well as some experience programming in Python.
:::

We'll build an connector for the Survey Monkey API, focusing on the `surveys` and `survey responses`
endpoints.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-to-airbyte/submit-new-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The token must be a (classic) token with repo scope enabled. Follow these direct

### Find or start a Github Discussion about the connector

While Connector Builder is great, some [connectors won't work in the Builder just yet](../connector-development/connector-builder-ui/connector-builder-compatibility.md).
While our Connector Builder is constantly growing and evolving in flexibility and supported use cases, some connector implementations won't work in the Builder just yet.
See the [Connector Development guide](../connector-development/README.md) for more details on how to build a connector. If you're building a custom Python CDK or Database (Java CDK) connector, please start with filing a discussion or an issue:

1. Check to see if there is an existing [Discussion](https://github.com/airbytehq/airbyte/discussions/categories/new-connector-request) for a connector you have in mind
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,6 @@
- from:
- /deploying-airbyte/quickstart
to: /using-airbyte/getting-started/oss-quickstart
- from:
- /connector-development/connector-builder-ui/compatibility-guide
to: /connector-development/connector-builder-ui/overview
1 change: 0 additions & 1 deletion docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,6 @@ const buildAConnector = {
label: "No-Code Connector Builder",
items: [
"connector-development/connector-builder-ui/overview",
"connector-development/connector-builder-ui/connector-builder-compatibility",
"connector-development/connector-builder-ui/tutorial",
"connector-development/connector-builder-ui/ai-assist",
{
Expand Down
Loading