Skip to content
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
003a499
Create orgs and workspaces section
ian-at-airbyte Sep 11, 2025
6635155
Create the new organizaton and workspace section, move relevant topic…
ian-at-airbyte Sep 13, 2025
15f4dea
Refined the organization explanation a bit, and added somewhat better…
ian-at-airbyte Sep 13, 2025
31c6eb1
Update workspace subsection
ian-at-airbyte Sep 18, 2025
8667abd
Add actual connector update steps to the connector update page, then …
ian-at-airbyte Sep 19, 2025
c3a4106
Update a variety of other pages that referenced the old Settings UI
ian-at-airbyte Sep 19, 2025
8a58653
Merge branch 'master' into docs-orgs-and-workspaces
ian-at-airbyte Sep 19, 2025
5fbe3d4
Fix a technical error with Cloud
ian-at-airbyte Sep 19, 2025
960799c
Fix two broken links
ian-at-airbyte Sep 19, 2025
99580ba
Fix a few more references to the old UI
ian-at-airbyte Sep 20, 2025
29fce44
Update screenshots
ian-at-airbyte Sep 20, 2025
cd06e5b
Remaining platform screenshot updates or deletions
ian-at-airbyte Sep 22, 2025
19e5d74
Updated and deleting remaining screenshots in the integrations folder…
ian-at-airbyte Sep 22, 2025
483f863
Update Embedded screenshots
ian-at-airbyte Sep 22, 2025
d57a646
Update steps for platform docs that referenced the old "Settings" opt…
ian-at-airbyte Sep 22, 2025
012ef1f
Merge branch 'master' into docs-orgs-and-workspaces
ian-at-airbyte Sep 22, 2025
6ba0a33
Update docs/integrations/sources/zendesk-chat-migrations.md
ian-at-airbyte Sep 22, 2025
c933970
Update docs/platform/cloud/managing-airbyte-cloud/manage-data-residen…
ian-at-airbyte Sep 22, 2025
db6334c
Update docs/platform/managing-airbyte/connector-updates.md
ian-at-airbyte Sep 22, 2025
c95ae2e
Update docs/platform/contributing-to-airbyte/developing-locally.md
ian-at-airbyte Sep 22, 2025
b6ec358
Update docs/platform/managing-airbyte/connector-updates.md
ian-at-airbyte Sep 22, 2025
f36dcb8
Update docs/platform/contributing-to-airbyte/developing-locally.md
ian-at-airbyte Sep 22, 2025
f000947
Update docs/platform/managing-airbyte/connector-updates.md
ian-at-airbyte Sep 22, 2025
dc3abfa
Add reusable block for connector upgrades
ian-at-airbyte Sep 24, 2025
6ed5788
Update connector migration guides to use a reusable block of text ins…
ian-at-airbyte Sep 24, 2025
ecf49ef
Fix a typo
ian-at-airbyte Sep 24, 2025
cde2ce7
Added some best practices to assigning org vs. workspace roles
ian-at-airbyte Sep 24, 2025
360af8a
Implement adjustments from reviewers' comments
ian-at-airbyte Sep 25, 2025
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
Binary file modified docs/ai-agents/assets/embedded-workspaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/ai-agents/embedded/widget/assets/embedded-workspaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/ai-agents/embedded/widget/managing-embedded.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Airbyte Embedded is built upon the Airbyte Platform. As the owner of your embedd

![Selected workspaces.](./assets/embedded-workspaces.png)


## Enabling Connectors within the Widget

Source connectors can be configured to appear in the Embedded widget by creating a configuration template [via the source_template endpoint](https://api.airbyte.ai/api/v1/docs#tag/Template-Sources/operation/create_integrations_templates_sources).
Expand Down
8 changes: 8 additions & 0 deletions docs/integrations/custom-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ See the following guides for more information on building custom Airbyte Docker

## Upgrading a connector

Follow these steps to upgrade a connector version.

1. In the navigaton bar, click **Workspace settings** > **Sources**/**Destinations**.

2. Find your connector in the list and click the edit button <svg fill="none" data-icon="pencil" role="img" viewBox="0 0 24 24" class="inline-svg"><path fill="currentColor" d="M22 7.24a1 1 0 0 0-.29-.71l-4.24-4.24a1 1 0 0 0-.71-.29 1 1 0 0 0-.71.29l-2.83 2.83L2.29 16.05a1 1 0 0 0-.29.71V21a1 1 0 0 0 1 1h4.24a1 1 0 0 0 .76-.29l10.87-10.93L21.71 8q.138-.146.22-.33.015-.12 0-.24a.7.7 0 0 0 0-.14zM6.83 20H4v-2.83l9.93-9.93 2.83 2.83zM18.17 8.66l-2.83-2.83 1.42-1.41 2.82 2.82z"></path></svg>.

3. In the dialog, update the Docker image tag to the new version.

To upgrade your connector version, go to the Settings in the left hand side of the UI and navigate to either Sources or Destinations. Find your connector in the list, and input the latest connector version.

![](/.gitbook/assets/upgrade-connector-version.png)
52 changes: 5 additions & 47 deletions docs/integrations/sources/asana-migrations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md';

# Asana Migration Guide

## Upgrading to 1.0.0
Expand All @@ -7,52 +9,8 @@ As part of our commitment to delivering exceptional service, we are transitionin
This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog.
However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

This release introduces an updated data type of the `name` field in the `events` stream. Users will need to reset this stream after upgrading.

## Connector Upgrade Guide

### For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

1. Select **Settings** in the main navbar.
1. Select **Sources**.
2. Find Gitlab in the list of connectors.

:::note
You will see two versions listed, the current in-use version and the latest version available.
:::

3. Select **Change** to update your OSS version to the latest available version.

### Update the connector version

1. Select **Sources** in the main navbar.
2. Select the instance of the connector you wish to upgrade.

:::note
Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
:::

3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### Refresh affected schemas and reset data

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab. 1. Select **Refresh source schema**. 2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page. 1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::
This release introduces an updated data type of the `name` field in the `events` stream. You must clear this stream after upgrading.

For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear).
## Connector upgrade guide

<MigrationGuide />
96 changes: 6 additions & 90 deletions docs/integrations/sources/gitlab-migrations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md';

# Gitlab Migration Guide

## Upgrading to 4.0.0
Expand All @@ -10,104 +12,18 @@ However, due to differences between the Python and low-code CDKs, this migration
The primary key was changed for streams `group_members`, `group_labels`, `project_members`, `project_labels`, `branches`, and `tags`.
Users will need to reset the affected streams after upgrading.

## Connector Upgrade Guide

### For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

1. Select **Settings** in the main navbar.
1. Select **Sources**.
2. Find Gitlab in the list of connectors.

:::note
You will see two versions listed, the current in-use version and the latest version available.
:::

3. Select **Change** to update your OSS version to the latest available version.

### Update the connector version

1. Select **Sources** in the main navbar.
2. Select the instance of the connector you wish to upgrade.

:::note
Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
:::

3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### Refresh affected schemas and reset data

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab. 1. Select **Refresh source schema**. 2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page. 1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::

For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear).
<MigrationGuide />

## Upgrading to 3.0.0

In this release, `merge_request_commits` stream schema has been fixed so that it returns commits for each merge_request.
Users will need to refresh the source schema and reset `merge_request_commits` stream after upgrading.

## Connector Upgrade Guide

### For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

1. Select **Settings** in the main navbar.
1. Select **Sources**.
2. Find Gitlab in the list of connectors.

:::note
You will see two versions listed, the current in-use version and the latest version available.
:::

3. Select **Change** to update your OSS version to the latest available version.

### Update the connector version

1. Select **Sources** in the main navbar.
2. Select the instance of the connector you wish to upgrade.

:::note
Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
:::

3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### Refresh affected schemas and reset data
<MigrationGuide />

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab. 1. Select **Refresh source schema**. 2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page. 1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::
## Connector upgrade guide

For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear).
<MigrationGuide />

## Upgrading to 2.0.0

Expand Down
9 changes: 1 addition & 8 deletions docs/integrations/sources/jira-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,7 @@ Users who do not have this stream enabled will not be affected and can safely up
3. Disable the `pull_requests` stream
4. In the main navbar, navigate to the **Sources** tab and select the affected Jira source. Set the `enable_experimental_streams` field to false and save your changes.

:::note
For **OSS users**, the **Pull Request** stream can still be synced by pinning this source to an earlier version:

1. Select **Settings** in the main navbar.
2. Select **Sources**, edit the entry for `source-jira` and set the **Default Version** to `3.5.4`

This feature is not available in **Airbyte Cloud**
:::
If you're a self-managed user and can't upgrade to the new version yet, you can pin the connector to a specific version. [Help managing upgrades](/platform/next/managing-airbyte/connector-updates).

## Upgrading to 3.0.0

Expand Down
49 changes: 4 additions & 45 deletions docs/integrations/sources/metabase-migrations.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,11 @@
import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md';

# Metabase Migration Guide

## Upgrading to 2.0.0

Source Metabase has updated the `dashboards` stream's endpoint due to the previous endpoint being deprecated by the service. The new version no longer returns the `creator` field for the `dashboards` stream.

## Connector Upgrade Guide

### For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

1. Select **Settings** in the main navbar.
1. Select **Sources**.
2. Find Metabase in the list of connectors.

:::note
You will see two versions listed, the current in-use version and the latest version available.
:::

3. Select **Change** to update your OSS version to the latest available version.

### Update the connector version

1. Select **Sources** in the main navbar.
2. Select the instance of the connector you wish to upgrade.

:::note
Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
:::

3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### Refresh affected schemas and reset data

1. Select **Connections** in the main navbar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab. 1. Select **Refresh source schema**. 2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page. 1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::
## Connector upgrade guide

For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear).
<MigrationGuide />
49 changes: 4 additions & 45 deletions docs/integrations/sources/mixpanel-migrations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md';

# Mixpanel Migration Guide

## Upgrading to 3.0.0
Expand All @@ -13,52 +15,9 @@ To gracefully handle these changes for your existing connections, we highly reco
To add start date filtering for the `Cohorts`, `CohortMembers`, and `Engage` streams, the default retrieval range has been updated from all existing records to only include records created within the past year if start date not provided.
:::

## Migration Steps

### For Airbyte Open Source: Update the local connector image

Airbyte Open Source users must manually update the connector image in their local registry before proceeding with the migration. To do so:

1. Select **Settings** in the main navbar.
1. Select **Sources**.
2. Find `Mixpanel` in the list of connectors.

:::note
You will see two versions listed, the current in-use version and the latest version available.
:::

3. Select **Change** to update your OSS version to the latest available version.

### Update the connector version

1. Select **Sources** in the main navbar.
2. Select the instance of the connector you wish to upgrade.

:::note
Each instance of the connector must be updated separately. If you have created multiple instances of a connector, updating one will not affect the others.
:::

3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### Refresh affected schemas and reset data

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab. 1. Select **Refresh source schema**. 2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page. 1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::
## Connector upgrade guide

For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear).
<MigrationGuide />

## Upgrading to 2.0.0

Expand Down
Loading
Loading