From 8288c16485eb44a660bdd387749de7acc09cae1e Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Wed, 24 Aug 2022 09:31:53 +0530 Subject: [PATCH] fix: replace airbyte oss with airbyte open source (#15885) Co-authored-by: Marcos Marx --- docs/integrations/destinations/bigquery.md | 4 ++-- docs/integrations/destinations/google-sheets.md | 2 +- docs/integrations/destinations/redshift.md | 2 +- docs/integrations/destinations/s3.md | 2 +- docs/integrations/sources/amazon-ads.md | 2 +- docs/integrations/sources/amazon-seller-partner.md | 2 +- docs/integrations/sources/amplitude.md | 2 +- docs/integrations/sources/appfollow.md | 2 +- docs/integrations/sources/bing-ads.md | 2 +- docs/integrations/sources/freshdesk.md | 2 +- docs/integrations/sources/github.md | 6 ++++-- docs/integrations/sources/google-ads.md | 12 ++++++------ .../sources/google-analytics-universal-analytics.md | 2 +- docs/integrations/sources/google-search-console.md | 2 +- docs/integrations/sources/google-sheets.md | 4 ++-- docs/integrations/sources/harvest.md | 2 +- docs/integrations/sources/hubplanner.md | 4 ++-- docs/integrations/sources/hubspot.md | 6 +++--- docs/integrations/sources/instagram.md | 2 +- docs/integrations/sources/intercom.md | 4 ++-- docs/integrations/sources/klaviyo.md | 2 +- docs/integrations/sources/linkedin-ads.md | 2 +- docs/integrations/sources/mailchimp.md | 9 +++++---- docs/integrations/sources/notion.md | 4 ++-- docs/integrations/sources/okta.md | 4 ++-- docs/integrations/sources/paypal-transaction.md | 2 +- docs/integrations/sources/postgres.md | 8 ++++---- docs/integrations/sources/recharge.md | 2 +- docs/integrations/sources/s3.md | 2 +- docs/integrations/sources/salesforce.md | 2 +- docs/integrations/sources/smartsheets.md | 2 +- docs/integrations/sources/snapchat-marketing.md | 4 ++-- docs/integrations/sources/stripe.md | 4 ++-- docs/integrations/sources/surveymonkey.md | 4 ++-- docs/integrations/sources/tiktok-marketing.md | 2 +- docs/integrations/sources/zendesk-support.md | 8 ++++---- 36 files changed, 65 insertions(+), 62 deletions(-) diff --git a/docs/integrations/destinations/bigquery.md b/docs/integrations/destinations/bigquery.md index cc5c7d82a887..4bba5f763126 100644 --- a/docs/integrations/destinations/bigquery.md +++ b/docs/integrations/destinations/bigquery.md @@ -12,7 +12,7 @@ This page guides you through setting up the BigQuery destination connector. **Note:** Queries written in BigQuery can only reference datasets in the same physical location. If you plan on combining the data that Airbyte syncs with data from other datasets in your queries, create the datasets in the same location on Google Cloud. For more information, read [Introduction to Datasets](https://cloud.google.com/bigquery/docs/datasets-intro) -- (Required for Airbyte Cloud; Optional for Airbyte OSS) A Google Cloud [Service Account](https://cloud.google.com/iam/docs/service-accounts) with the [`BigQuery User`](https://cloud.google.com/bigquery/docs/access-control#bigquery) and [`BigQuery Data Editor`](https://cloud.google.com/bigquery/docs/access-control#bigquery) roles and the [Service Account Key in JSON format](https://cloud.google.com/iam/docs/creating-managing-service-account-keys). +- (Required for Airbyte Cloud; Optional for Airbyte Open Source) A Google Cloud [Service Account](https://cloud.google.com/iam/docs/service-accounts) with the [`BigQuery User`](https://cloud.google.com/bigquery/docs/access-control#bigquery) and [`BigQuery Data Editor`](https://cloud.google.com/bigquery/docs/access-control#bigquery) roles and the [Service Account Key in JSON format](https://cloud.google.com/iam/docs/creating-managing-service-account-keys). ## Connector modes @@ -42,7 +42,7 @@ You can use BigQuery's [`INSERT`](https://cloud.google.com/bigquery/docs/referen ### Step 2: Set up the BigQuery connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Destinations** and then click **+ New destination**. 3. On the Set up the destination page, select **BigQuery** or **BigQuery (denormalized typed struct)** from the **Destination type** dropdown depending on whether you want to set up the connector in [BigQuery](#connector-modes) or [BigQuery (Denormalized)](#connector-modes) mode. 4. Enter the name for the BigQuery connector. diff --git a/docs/integrations/destinations/google-sheets.md b/docs/integrations/destinations/google-sheets.md index 2697c05f313f..ac15c5d60627 100644 --- a/docs/integrations/destinations/google-sheets.md +++ b/docs/integrations/destinations/google-sheets.md @@ -34,7 +34,7 @@ Visit the [Google Support](https://support.google.com/accounts/answer/27441?hl=e 4. Select `Sign in with Google`. 5. Log in and Authorize to the Instagram account and click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** At this moment the `Google Sheets Destination` works only with Airbyte Cloud. diff --git a/docs/integrations/destinations/redshift.md b/docs/integrations/destinations/redshift.md index 4f5bc232f32b..72fa76958469 100644 --- a/docs/integrations/destinations/redshift.md +++ b/docs/integrations/destinations/redshift.md @@ -65,7 +65,7 @@ Optional parameters: 4. Fill in all the required fields to use the INSERT or COPY strategy 5. Click `Set up destination`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Destinations**. In the top-right corner, click **+ new destination**. diff --git a/docs/integrations/destinations/s3.md b/docs/integrations/destinations/s3.md index 828c85ccdf3b..6d8613c00401 100644 --- a/docs/integrations/destinations/s3.md +++ b/docs/integrations/destinations/s3.md @@ -48,7 +48,7 @@ Prepare S3 bucket that will be used as destination, see [this](https://docs.aws. * The pattern allows you to set the file-name format for the S3 staging file(s), next placeholders combinations are currently supported: {date}, {date:yyyy_MM}, {timestamp}, {timestamp:millis}, {timestamp:micros}, {part_number}, {sync_id}, {format_extension}. Please, don't use empty space and not supportable placeholders, as they won't recognized. 5. Click `Set up destination`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Destinations**. In the top-right corner, click **+ new destination**. diff --git a/docs/integrations/sources/amazon-ads.md b/docs/integrations/sources/amazon-ads.md index 6d933272d59d..a69777b0130d 100644 --- a/docs/integrations/sources/amazon-ads.md +++ b/docs/integrations/sources/amazon-ads.md @@ -34,7 +34,7 @@ To use the [Amazon Ads API](https://advertising.amazon.com/API/docs/en-us), you 10. **Profile IDs (Optional)** you want to fetch data for. See [docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details. 11. Click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. **Client ID** of your Amazon Ads developer application. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details. 2. **Client Secret** of your Amazon Ads developer application. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details. diff --git a/docs/integrations/sources/amazon-seller-partner.md b/docs/integrations/sources/amazon-seller-partner.md index 7d93888223c9..0775dadc42cb 100644 --- a/docs/integrations/sources/amazon-seller-partner.md +++ b/docs/integrations/sources/amazon-seller-partner.md @@ -38,7 +38,7 @@ Authenticating this Alpha connector is currently blocked. This is a known issue 6. Paste all other data to required fields using your IAM user. 7. Click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Using developer application from Step 1, [generate](https://developer-docs.amazon.com/sp-api/docs/self-authorization) refresh token. 2. Go to local Airbyte page. diff --git a/docs/integrations/sources/amplitude.md b/docs/integrations/sources/amplitude.md index c00fb997fcd7..c7080f1c09f4 100644 --- a/docs/integrations/sources/amplitude.md +++ b/docs/integrations/sources/amplitude.md @@ -8,7 +8,7 @@ To set up the Amplitude source connector, you'll need your Amplitude [`API Key` ## Set up the Amplitude source connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Amplitude** from the Source type dropdown. 4. Enter a name for your source. diff --git a/docs/integrations/sources/appfollow.md b/docs/integrations/sources/appfollow.md index 95d57f4badd7..21f56ccac73c 100644 --- a/docs/integrations/sources/appfollow.md +++ b/docs/integrations/sources/appfollow.md @@ -8,7 +8,7 @@ To set up the Appfollow source connector, you'll need your Appfollow `ext_id`, ` ## Set up the Appfollow source connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Appfollow** from the Source type dropdown. 4. Enter a name for your source. diff --git a/docs/integrations/sources/bing-ads.md b/docs/integrations/sources/bing-ads.md index f9752b7ddbd8..0dfbbf3a1af8 100644 --- a/docs/integrations/sources/bing-ads.md +++ b/docs/integrations/sources/bing-ads.md @@ -35,7 +35,7 @@ This page guides you through the process of setting up the Bing Ads source conne 7. Choose required Start date 8. click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/freshdesk.md b/docs/integrations/sources/freshdesk.md index 071af3414f0c..34b10d984c88 100644 --- a/docs/integrations/sources/freshdesk.md +++ b/docs/integrations/sources/freshdesk.md @@ -31,7 +31,7 @@ Follow the link to read more about [how to find your API key](https://support.fr 6. Choose the `Start Date` as the starting point for your data replication. 5. Click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/github.md b/docs/integrations/sources/github.md index 6958d8385a04..968bb90bedbc 100644 --- a/docs/integrations/sources/github.md +++ b/docs/integrations/sources/github.md @@ -12,10 +12,12 @@ This page contains the setup guide and reference information for the GitHub sour * Personal Access Token (see [Permissions and scopes](https://docs.airbyte.com/integrations/sources/github#permissions-and-scopes)) * OAuth -**For Airbyte OSS:** + +**For Airbyte Open Source:** * Personal Access Token (see [Permissions and scopes](https://docs.airbyte.com/integrations/sources/github#permissions-and-scopes)) + ## Setup guide ### Step 1: Set up GitHub @@ -38,7 +40,7 @@ Log into [GitHub](https://github.com) and then generate a [personal access token 8. **Branch (Optional)** - Space-delimited list of GitHub repository branches to pull commits for, e.g. `airbytehq/airbyte/master`. If no branches are specified for a repository, the default branch will be pulled. (e.g. `airbytehq/airbyte/master airbytehq/airbyte/my-branch`). 9. **Page size for large streams (Optional)** - The GitHub connector contains several streams with a large load. The page size of such streams depends on the size of your repository. Recommended to specify values between 10 and 30. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Authenticate with **Personal Access Token**. ## Supported sync modes diff --git a/docs/integrations/sources/google-ads.md b/docs/integrations/sources/google-ads.md index a7c9bb023a12..f31a37de6cfc 100644 --- a/docs/integrations/sources/google-ads.md +++ b/docs/integrations/sources/google-ads.md @@ -5,19 +5,19 @@ This page contains the setup guide and reference information for the Google Ads ## Prerequisites - A [Google Ads Account](https://support.google.com/google-ads/answer/6366720) [linked](https://support.google.com/google-ads/answer/7459601) to a [Google Ads Manager account](https://ads.google.com/home/tools/manager-accounts/) -- (For Airbyte OSS) [A developer token](#step-1-for-airbyte-oss-apply-for-a-developer-token) +- (For Airbyte Open Source) [A developer token](#step-1-for-airbyte-oss-apply-for-a-developer-token) **Note**: The Google Ads connector usually pulls data up until the previous day. For example, if the sync runs on Wednesday 5pm, then data up until Tuesday midnight is pulled. Data for Wednesday is exported only if a sync runs after Wednesday e.g: 12:01am on Thursday, and so on. The connector does this to avoid syncing partial performance data, only to have to resync it again once the full day's data has been recorded by Google. For example, without this functionality, a sync which runs on Wednesday 5pm would get ads performance data for Wednesday between 12:01am-5pm on Wednesday, then it would need to run again once the day is done to get all of Wednesday's data once more. This is due to a limitation in the Google Ads API which does not allow getting performance data at a granularity level smaller than a day. ## Setup guide -### Step 1: (For Airbyte OSS) Apply for a developer token +### Step 1: (For Airbyte Open Source) Apply for a developer token :::note You'll need to create a [Google Ads Manager account](https://ads.google.com/home/tools/manager-accounts/) since Google Ads accounts cannot generate a developer token. ::: -To set up the Google Ads source connector with Airbyte OSS, you'll need a developer token. This token allows you to access your data from the Google Ads API. However, Google is selective about which software and use cases can get a developer token. The Airbyte team has worked with the Google Ads team to allowlist Airbyte and make sure you can get a developer token (see [issue 1981](https://github.com/airbytehq/airbyte/issues/1981) for more information). +To set up the Google Ads source connector with Airbyte Open Source, you'll need a developer token. This token allows you to access your data from the Google Ads API. However, Google is selective about which software and use cases can get a developer token. The Airbyte team has worked with the Google Ads team to allowlist Airbyte and make sure you can get a developer token (see [issue 1981](https://github.com/airbytehq/airbyte/issues/1981) for more information). Follow [Google's instructions](https://developers.google.com/google-ads/api/docs/first-call/dev-token) to apply for the token. Note that you will _not_ be able to access your data via the Google Ads API until this token is approved. You cannot use a test developer token; it has to be at least a basic developer token. It usually takes Google 24 hours to respond to these applications. @@ -47,11 +47,11 @@ To set up Google Ads as a source in Airbyte Cloud: 11. (Optional) Enter the **End Date** in YYYY-MM-DD format. The data added after this date will not be replicated. 12. Click **Set up source**. -#### For Airbyte OSS +#### For Airbyte Open Source -To set up Google Ads as a source in Airbyte OSS: +To set up Google Ads as a source in Airbyte Open Source: -1. Log into your Airbyte OSS account. +1. Log into your Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Google Ads** from the Source type dropdown. 4. Enter a **Name** for your source. diff --git a/docs/integrations/sources/google-analytics-universal-analytics.md b/docs/integrations/sources/google-analytics-universal-analytics.md index c88a4be35adc..e6bfbae2d90c 100644 --- a/docs/integrations/sources/google-analytics-universal-analytics.md +++ b/docs/integrations/sources/google-analytics-universal-analytics.md @@ -25,7 +25,7 @@ Decide which Views you'd like to sync, prepare View IDs. Decide what date you'd 5. Find your View ID for the view you want to fetch data from. Find it [here](https://ga-dev-tools.web.app/account-explorer/). 6. Enter a start date, and custom report information. -**For Airbyte OSS:** +**For Airbyte Open Source:** There are 2 options of setting up authorization for this source: diff --git a/docs/integrations/sources/google-search-console.md b/docs/integrations/sources/google-search-console.md index 7fb197b46bbb..2b1a787bd668 100644 --- a/docs/integrations/sources/google-search-console.md +++ b/docs/integrations/sources/google-search-console.md @@ -68,7 +68,7 @@ At the end of this process, you should have JSON credentials to this Google Serv 5. Fill in the `start date` field. 6. You should be ready to sync data. -### For Airbyte OSS: +### For Airbyte Open Source: 1. Fill in the `service_account_info` and `email` fields for authentication. 2. Fill in the `site_urls` field. diff --git a/docs/integrations/sources/google-sheets.md b/docs/integrations/sources/google-sheets.md index 002bd2f3d930..4406db0dca59 100644 --- a/docs/integrations/sources/google-sheets.md +++ b/docs/integrations/sources/google-sheets.md @@ -22,9 +22,9 @@ To set up Google Sheets as a source in Airbyte Cloud: 6. For Spreadsheet Link, enter the link to the Google spreadsheet. To get the link, go to the Google spreadsheet you want to sync, click **Share** in the top right corner, and click **Copy Link**. 7. For Row Batch Size, define the number of records you want the Google API to fetch at a time. The default value is 200. -### For Airbyte OSS +### For Airbyte Open Source -To set up Google Sheets as a source in Airbyte OSS: +To set up Google Sheets as a source in Airbyte Open Source: 1. [Enable the Google Cloud Platform APIs for your personal or organization account](https://support.google.com/googleapi/answer/6158841?hl=en). diff --git a/docs/integrations/sources/harvest.md b/docs/integrations/sources/harvest.md index 5208b0dbcd67..0dcd05e6ffdc 100644 --- a/docs/integrations/sources/harvest.md +++ b/docs/integrations/sources/harvest.md @@ -27,7 +27,7 @@ This connector supports only authentication with API Key. To obtain API key foll 6. Enter the `replication_start_date` you want your sync to start from 7. Click **Set up source** -### For Airbyte OSS: +### For Airbyte Open Source: 1. Navigate to the Airbyte Open Source dashboard 2. Set the name for your source 3. Enter your `api_token` diff --git a/docs/integrations/sources/hubplanner.md b/docs/integrations/sources/hubplanner.md index e6e1e2648edf..4256522aacb4 100644 --- a/docs/integrations/sources/hubplanner.md +++ b/docs/integrations/sources/hubplanner.md @@ -5,7 +5,7 @@ Hubplanner is a tool to plan, schedule, report and manage your entire team. ## Prerequisites * Create the API Key to access your data in Hubplanner. -## Airbyte OSS +## Airbyte Open Source * API Key ## Airbyte Cloud @@ -13,7 +13,7 @@ Hubplanner is a tool to plan, schedule, report and manage your entire team. ## Setup guide -### For Airbyte OSS: +### For Airbyte Open Source: 1. Access https://your-domain.hubplanner.com/settings#api or access the panel in left side Integrations/Hub Planner API 2. Click in Generate Key diff --git a/docs/integrations/sources/hubspot.md b/docs/integrations/sources/hubspot.md index 4386725a4e8b..6cbd69426254 100644 --- a/docs/integrations/sources/hubspot.md +++ b/docs/integrations/sources/hubspot.md @@ -33,14 +33,14 @@ You can use OAuth, API key, or Private App to authenticate your HubSpot account. ## Set up the HubSpot source connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **HubSpot** from the Source type dropdown. 4. Enter a name for your source. 5. For **Start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. -6. You can use OAuth or an API key to authenticate your HubSpot account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS. +6. You can use OAuth or an API key to authenticate your HubSpot account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte Open Source. - To authenticate using OAuth for Airbyte Cloud, ensure you have [set the appropriate scopes for HubSpot](#prerequisite) and then click **Authenticate your HubSpot account** to sign in with HubSpot and authorize your account. - - To authenticate using an API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter the [API key](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for your HubSpot account. + - To authenticate using an API key for Airbyte Open Source, select **API key** from the Authentication dropdown and enter the [API key](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for your HubSpot account. :::note Check the [performance considerations](#performance-considerations) before using an API key. ::: diff --git a/docs/integrations/sources/instagram.md b/docs/integrations/sources/instagram.md index 898e67767619..bc6ba5786436 100644 --- a/docs/integrations/sources/instagram.md +++ b/docs/integrations/sources/instagram.md @@ -38,7 +38,7 @@ Follow the [Instagram documentation](https://www.facebook.com/business/help/1492 4. Select `Authenticate your account`. 5. Log in and Authorize to the Instagram account and click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. For using an Access Tokens, set up instagram (see step above). 2. Generate [Access Tokens](https://developers.facebook.com/docs/facebook-login/access-tokens/#usertokens) with the following permissions: diff --git a/docs/integrations/sources/intercom.md b/docs/integrations/sources/intercom.md index 98ce180c5bba..9fa249eb3819 100644 --- a/docs/integrations/sources/intercom.md +++ b/docs/integrations/sources/intercom.md @@ -4,13 +4,13 @@ This page guides you through the process of setting up the Intercom source conne ## Set up the Intercom connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Intercom** from the Source type dropdown. 4. Enter a name for your source. 5. For **Start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. 6. For Airbyte Cloud, click **Authenticate your Intercom account** to sign in with Intercom and authorize your account. - For Airbyte OSS, enter your [Access Token](https://developers.intercom.com/building-apps/docs/authentication-types#section-how-to-get-your-access-token) to authenticate your account. + For Airbyte Open Source, enter your [Access Token](https://developers.intercom.com/building-apps/docs/authentication-types#section-how-to-get-your-access-token) to authenticate your account. 7. Click **Set up source**. ## Supported sync modes diff --git a/docs/integrations/sources/klaviyo.md b/docs/integrations/sources/klaviyo.md index b63c00a6976f..d0e163452641 100644 --- a/docs/integrations/sources/klaviyo.md +++ b/docs/integrations/sources/klaviyo.md @@ -22,7 +22,7 @@ Please follow these [steps](https://help.klaviyo.com/hc/en-us/articles/115005062 5. Enter the date you want your sync to start from 6. Submit the form -### For Airbyte OSS: +### For Airbyte Open Source: 1. Navigate to the Airbyte Open Source dashboard 2. Set the name for your source 4. Enter you private API key from Prerequisites diff --git a/docs/integrations/sources/linkedin-ads.md b/docs/integrations/sources/linkedin-ads.md index bf6f00775a2f..439df170f975 100644 --- a/docs/integrations/sources/linkedin-ads.md +++ b/docs/integrations/sources/linkedin-ads.md @@ -103,7 +103,7 @@ To edit these roles, sign into Campaign Manager and follow [these instructions]( 7. Log in and Authorize to the LinkedIn Ads account 8. click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/mailchimp.md b/docs/integrations/sources/mailchimp.md index 7c6ae475c5e1..881662376102 100644 --- a/docs/integrations/sources/mailchimp.md +++ b/docs/integrations/sources/mailchimp.md @@ -8,13 +8,14 @@ You can use [OAuth](https://mailchimp.com/developer/marketing/guides/access-user ## Set up the Mailchimp source connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Mailchimp** from the Source type dropdown. 4. Enter a name for your source. -6. You can use OAuth or an API key to authenticate your Mailchimp account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS. - - To authenticate using OAuth for Airbyte Cloud, ensure you have [registered your Mailchimp account](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/#register-your-application) and then click **Authenticate your Mailchimp account** to sign in with Mailchimp and authorize your account. - - To authenticate using an API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter the [API key](https://mailchimp.com/developer/marketing/guides/quick-start/#generate-your-api-key) for your Mailchimp account. + +6. You can use OAuth or an API key to authenticate your Mailchimp account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte Open Source. + - To authenticate using OAuth for Airbyte Cloud, ensure you have [registered your Mailchimp account](#prerequisite) and then click **Authenticate your Mailchimp account** to sign in with Mailchimp and authorize your account. + - To authenticate using an API key for Airbyte Open Source, select **API key** from the Authentication dropdown and enter the [API key](https://mailchimp.com/developer/marketing/guides/quick-start/#generate-your-api-key) for your Mailchimp account. :::note Check the [performance considerations](#performance-considerations) before using an API key. ::: diff --git a/docs/integrations/sources/notion.md b/docs/integrations/sources/notion.md index ea6bf648c8bb..29fb1f1e6dc2 100644 --- a/docs/integrations/sources/notion.md +++ b/docs/integrations/sources/notion.md @@ -5,7 +5,7 @@ Notion is a productivity and project management software. It was designed to hel ## Prerequisites * Created Notion account with integration on [my integrations](https://www.notion.so/my-integrations) page. -## Airbyte OSS +## Airbyte Open Source * Start Date * Token (received when integration was created). @@ -40,7 +40,7 @@ Notion is a productivity and project management software. It was designed to hel 8. Log in and Authorize to the Notion account 10. Click `Set up source`. -### For Airbyte OSS: +### For Airbyte Open Source: 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. 3. On the Set up the source page, enter the name for the connector and select **Notion** from the Source type dropdown. diff --git a/docs/integrations/sources/okta.md b/docs/integrations/sources/okta.md index 03fc67e57f70..63ad83cce943 100644 --- a/docs/integrations/sources/okta.md +++ b/docs/integrations/sources/okta.md @@ -5,7 +5,7 @@ Okta is the complete identity solution for all your apps and people that’s uni ## Prerequisites * Created Okta account with added application on [Add Application Page](https://okta-domain.okta.com/enduser/catalog) page. (change okta-domain to you'r domain received after complete registration) -## Airbyte OSS +## Airbyte Open Source * Name * Okta-Domain * Start Date @@ -39,7 +39,7 @@ Okta is the complete identity solution for all your apps and people that’s uni 9. If you select OAuth2.0 authorization - fill the fields **Client ID**, **Client Secret**, **Refresh Token** 10. Click `Set up source`. -### For Airbyte OSS: +### For Airbyte Open Source: 1. Go to local Airbyte page. 2. Use API token from requirements and Okta [domain](https://developer.okta.com/docs/guides/find-your-domain/-/main/). diff --git a/docs/integrations/sources/paypal-transaction.md b/docs/integrations/sources/paypal-transaction.md index d52605b29f95..3141086330b4 100644 --- a/docs/integrations/sources/paypal-transaction.md +++ b/docs/integrations/sources/paypal-transaction.md @@ -22,7 +22,7 @@ In order to get an `Client ID` and `Secret` please go to [this](https://develope 6. Enter the date you want your sync to start from 7. Click **Set up source**. -### For Airbyte OSS: +### For Airbyte Open Source: 1. Navigate to the Airbyte Open Source dashboard 2. Set the name for your source 3. Enter your client id diff --git a/docs/integrations/sources/postgres.md b/docs/integrations/sources/postgres.md index b9644890249f..976b8d208598 100644 --- a/docs/integrations/sources/postgres.md +++ b/docs/integrations/sources/postgres.md @@ -15,10 +15,10 @@ If your dataset is small and you just want a snapshot of your table in the desti ## Prerequisites -- For Airbyte OSS users, [upgrade](https://docs.airbyte.com/operator-guides/upgrading-airbyte/) your Airbyte platform to version `v0.40.0-alpha` or newer +- For Airbyte Open Source users, [upgrade](https://docs.airbyte.com/operator-guides/upgrading-airbyte/) your Airbyte platform to version `v0.40.0-alpha` or newer - Use Postgres v9.3.x or above for non-CDC workflows and Postgres v10 or above for CDC workflows - Allowlist the IP address `34.106.109.131` to enable access to Airbyte -- For Airbyte Cloud (and optionally for Airbyte OSS), ensure SSL is enabled in your environment +- For Airbyte Cloud (and optionally for Airbyte Open Source), ensure SSL is enabled in your environment ## Setup guide @@ -87,7 +87,7 @@ This issue is tracked in [#9771](https://github.com/airbytehq/airbyte/issues/977 ### Step 2: Set up the Postgres connector in Airbyte -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Postgres** from the Source type dropdown. 4. Enter a name for your source. @@ -112,7 +112,7 @@ This issue is tracked in [#9771](https://github.com/airbytehq/airbyte/issues/977 This is an advanced configuration option. Users are advised to use it with caution. ::: -9. For Airbyte OSS, toggle the switch to connect using SSL. Airbyte Cloud uses SSL by default. +9. For Airbyte Open Source, toggle the switch to connect using SSL. Airbyte Cloud uses SSL by default. 10. For Replication Method, select Standard or [Logical CDC](https://www.postgresql.org/docs/10/logical-replication.html) from the dropdown. Refer to [Configuring Postgres connector with Change Data Capture (CDC)](#configuring-postgres-connector-with-change-data-capture-cdc) for more information. 11. For SSH Tunnel Method, select: - No Tunnel for a direct connection to the database diff --git a/docs/integrations/sources/recharge.md b/docs/integrations/sources/recharge.md index 6987c34172ab..5078208e7bd3 100644 --- a/docs/integrations/sources/recharge.md +++ b/docs/integrations/sources/recharge.md @@ -22,7 +22,7 @@ Please read [How to generate your API token](https://support.rechargepayments.co 5. Enter your `Access Token`. 6. click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/s3.md b/docs/integrations/sources/s3.md index 3eeaddfde2dd..b1a50341ae64 100644 --- a/docs/integrations/sources/s3.md +++ b/docs/integrations/sources/s3.md @@ -25,7 +25,7 @@ Define file pattern, see the [Path Patterns section](s3.md#path-patterns) 7. Fill in the fields within the provider box appropriately. If your bucket is not public, add [credentials](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) with sufficient permissions under `aws_access_key_id` and `aws_secret_access_key`. 8. Choose the format corresponding to the format of your files and fill in fields as required. If unsure about values, try out the defaults and come back if needed. Find details on these settings [here](s3.md#file-format-settings). -### For Airbyte OSS: +### For Airbyte Open Source: 1. Create a new S3 source with a suitable name. Since each S3 source maps to just a single table, it may be worth including that in the name. 2. Set `dataset` appropriately. This will be the name of the table in the destination. diff --git a/docs/integrations/sources/salesforce.md b/docs/integrations/sources/salesforce.md index ce50e1cfdf55..a6f1d7fc67dd 100644 --- a/docs/integrations/sources/salesforce.md +++ b/docs/integrations/sources/salesforce.md @@ -48,7 +48,7 @@ To set up Salesforce as a source in Airbyte Cloud: 8. Click **Authenticate your account** to authorize your Salesforce account. Airbyte will authenticate the Salesforce account you are already logged in to. Make sure you are logged into the right account. 9. Click **Set up source**. -### For Airbyte OSS +### For Airbyte Open Source To set up Salesforce as a source in Airbyte Open Source: diff --git a/docs/integrations/sources/smartsheets.md b/docs/integrations/sources/smartsheets.md index 91e71f498581..4d86b4f41038 100644 --- a/docs/integrations/sources/smartsheets.md +++ b/docs/integrations/sources/smartsheets.md @@ -40,7 +40,7 @@ You'll also need the ID of the Spreadsheet you'd like to sync. Unlike Google She 5. Enter the start date and the ID of the spreadsheet you want to sync 6. Submit the form -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Navigate to the Airbyte Open Source dashboard 2. Set the name for your source 3. Enter the API access token from Prerequisites diff --git a/docs/integrations/sources/snapchat-marketing.md b/docs/integrations/sources/snapchat-marketing.md index f238e085ba4d..69d930ed60f0 100644 --- a/docs/integrations/sources/snapchat-marketing.md +++ b/docs/integrations/sources/snapchat-marketing.md @@ -15,7 +15,7 @@ This page guides you through the process of setting up the Snapchat Marketing so 1. [Set up Snapchat Business account](https://businesshelp.snapchat.com/s/article/get-started?language=en_US) -### For Airbyte OSS: +### For Airbyte Open Source: 2. [Activate Access to the Snapchat Marketing API](https://businesshelp.snapchat.com/s/article/api-apply?language=en_US) 3. Add the OAuth2 app: @@ -52,7 +52,7 @@ The useful link to Authentication process is [here](https://marketingapi.snapcha 6. Choose required Start date 7. click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/stripe.md b/docs/integrations/sources/stripe.md index 4134378e7b02..cac49f62010f 100644 --- a/docs/integrations/sources/stripe.md +++ b/docs/integrations/sources/stripe.md @@ -9,8 +9,8 @@ This page guides you through the process of setting up the Stripe source connect ## Set up the Stripe source connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. -2. Click **Sources** and then click **+ New source**. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. +2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Stripe** from the Source type dropdown. 4. Enter a name for your source. 5. For **Account ID**, enter your [Stripe `Account ID`](https://dashboard.stripe.com/settings/account). diff --git a/docs/integrations/sources/surveymonkey.md b/docs/integrations/sources/surveymonkey.md index f10e122ae588..04788bc0439d 100644 --- a/docs/integrations/sources/surveymonkey.md +++ b/docs/integrations/sources/surveymonkey.md @@ -4,7 +4,7 @@ This page guides you through the process of setting up the SurveyMonkey source c ## Prerequisites - ### For Airbyte OSS: + ### For Airbyte Open Source: * Access Token ## Setup guide @@ -23,7 +23,7 @@ Please read this [docs](https://developer.surveymonkey.com/api/v3/#getting-start 6. Choose required Start date 7. click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/tiktok-marketing.md b/docs/integrations/sources/tiktok-marketing.md index ca8bfec2c33b..120c74decabf 100644 --- a/docs/integrations/sources/tiktok-marketing.md +++ b/docs/integrations/sources/tiktok-marketing.md @@ -33,7 +33,7 @@ To access the Sandbox environment: 6. Choose required Start date 7. click `Set up source`. -**For Airbyte OSS:** +**For Airbyte Open Source:** 1. Go to local Airbyte page. 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**. diff --git a/docs/integrations/sources/zendesk-support.md b/docs/integrations/sources/zendesk-support.md index b7d4c7eede3b..f24a534f5952 100644 --- a/docs/integrations/sources/zendesk-support.md +++ b/docs/integrations/sources/zendesk-support.md @@ -5,19 +5,19 @@ This page guides you through setting up the Zendesk Support source connector. ## Prerequisites - Locate your Zendesk subdomain found in your account URL. For example, if your account URL is `https://{MY_SUBDOMAIN}.zendesk.com/`, then `MY_SUBDOMAIN` is your subdomain. -- (For Airbyte OSS) Find the email address associated with your Zendesk account. Also, generate an [API token](https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token) for the account. +- (For Airbyte Open Source) Find the email address associated with your Zendesk account. Also, generate an [API token](https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token) for the account. ## Set up the Zendesk Support source connector -1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte OSS account. +1. Log into your [Airbyte Cloud](https://cloud.airbyte.io/workspaces) or Airbyte Open Source account. 2. Click **Sources** and then click **+ New source**. 3. On the Set up the source page, select **Zendesk Support** from the Source type dropdown. 4. Enter a name for your source. 5. For **Subdomain**, enter your [Zendesk subdomain](#prerequisites). 6. For **Start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. -7. You can use OAuth or an API key to authenticate your Zendesk Support account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS. +7. You can use OAuth or an API key to authenticate your Zendesk Support account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte Open Source. - To authenticate using OAuth for Airbyte Cloud, click **Authenticate your Zendesk Support account** to sign in with Zendesk Support and authorize your account. - - To authenticate using an API key for Airbyte OSS, select **API key** from the Authentication dropdown and enter your [API key](#prerequisites). Enter the **Email** associated with your Zendesk Support account. + - To authenticate using an API key for Airbyte Open Source, select **API key** from the Authentication dropdown and enter your [API key](#prerequisites). Enter the **Email** associated with your Zendesk Support account. 8. Click **Set up source**. ## Supported sync modes