f488a04b69
## What Regenerates platform documentation version 2.0 from the latest Next (unreleased) version. This publishes all recent documentation updates that have been made to the Next version as the stable 2.0 release. Requested by Ian Alton (@ian-at-airbyte) via Slack thread: https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760747793195139?thread_ts=1760747793.195139 Link to Devin session: https://app.devin.ai/sessions/edbc303b017445de9731080a55c04586 ## How 1. Deleted the existing `version-2.0` directory from `platform_versioned_docs/` 2. Deleted the `version-2.0-sidebars.json` from `platform_versioned_sidebars/` 3. Temporarily removed `"2.0"` from `platform_versions.json` 4. Ran `pnpm docusaurus docs:version:platform 2.0` to regenerate version 2.0 from the current Next version 5. Verified the build succeeds locally ## Review guide 1. **New content**: `platform_versioned_docs/version-2.0/understanding-airbyte/cdc-best-practices.md` - Comprehensive new CDC configuration best practices guide. Review for technical accuracy. 2. **Sidebar changes**: `platform_versioned_sidebars/version-2.0-sidebars.json` - CDC content reorganized under "Sync Modes" section. Verify navigation makes sense. 3. **Terminology updates** throughout various files: - "Airbyte Open Source" → "Core" - "Cloud Teams" → "Cloud Pro" - "Self-Managed Community" → "Core" - Verify these align with actual product naming conventions 4. **Content improvements** in access management, API documentation, connector development, enterprise setup, and quickstart guides ## User Impact Users viewing the version 2.0 platform documentation will see the latest content updates, including: - New comprehensive CDC best practices documentation - Updated terminology reflecting current product names - Improved clarity and accuracy throughout documentation - Better organization of CDC-related content No negative side effects expected - this is a documentation-only update. ## Can this PR be safely reverted and rolled back? - [x] YES 💚 This is a documentation change only. Reverting would restore the previous version 2.0 documentation content. --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
5.0 KiB
5.0 KiB
Connector Development
If you'd like to build a connector that doesn't yet exist in Airbyte's catalog, in most cases you should use Connector Builder! Builder works for most API source connectors as long as you can read the data with HTTP requests (REST, GraphQL) and get results in JSON or JSONL formats, CSV and XML support to come soon.
In rare cases when you need something more complex, you can use the Low-Code CDK directly. Other options and SDKs are described below.
:::note
Before building a new connector, review Airbyte's data protocol specification. As you begin, you should also familiarize yourself with our guide to Best Practices for Connector Development. If you need support along the way, visit the Slack channel we have dedicated to helping users with connector development where you can search previous discussions or ask a question of your own.
:::
Process overview
- 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.
- 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!
- Contribute back to Airbyte. If you want to contribute what you’ve built to the connector Marketplace, follow the steps provided in the contribution guide for submitting new connectors.
Connector development options
| Tool | Description |
|---|---|
| Connector Builder | We recommend Connector Builder for developing a connector for an API source. If you’re using Airbyte Cloud, no local developer environment is required to create a new connection with the Connector Builder because you configure it directly in the Airbyte web UI. This tool guides you through creating and testing a connection. Refer to our tutorial on the Connector Builder to guide you through the basics. Building destination connectors isn't supported in the Connector Builder. |
| Low Code Connector Development Kit (CDK) | This framework lets you build source connectors for HTTP API sources. The Low-code CDK is a declarative framework that allows you to describe the connector using a YAML schema without writing Python code. It’s flexible enough to include custom Python components in conjunction with this method if necessary. Building destination connectors isn't supported in the low-code CDK. |
| Python Connector Development Kit (CDK) | While this method provides the most flexibility to developers, it also requires the most code and maintenance. This library provides classes that work out-of-the-box for most scenarios you’ll encounter along with the generators to make the connector scaffolds for you. We maintain an in-depth guide to building a connector using the Python CDK. |
| Java CDK | If you're bulding a source or a destination against a traditional database (not an HTTP API, not a vector database), you should use the Java CDK instead. |
Community maintained CDKs
Airbyte doesn't officially support these CDKs. Use them with caution.
- The Typescript CDK is actively maintained by Faros.ai for use in their product.
- The Airbyte Dotnet CDK in C#.