Skip to content

Commit

Permalink
fix: replace airbyte oss with airbyte open source (#15885)
Browse files Browse the repository at this point in the history
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
  • Loading branch information
Jagrutiti and marcosmarxm authored Aug 24, 2022
1 parent 35b0b1b commit 8288c16
Show file tree
Hide file tree
Showing 36 changed files with 65 additions and 62 deletions.
4 changes: 2 additions & 2 deletions docs/integrations/destinations/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/destinations/google-sheets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/destinations/redshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/destinations/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/amazon-ads.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/amazon-seller-partner.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/amplitude.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/appfollow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/bing-ads.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/freshdesk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
6 changes: 4 additions & 2 deletions docs/integrations/sources/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
12 changes: 6 additions & 6 deletions docs/integrations/sources/google-ads.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/google-search-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/sources/google-sheets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/harvest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/sources/hubplanner.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ 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
* Comming Soon.


## 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
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/sources/hubspot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/instagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/sources/intercom.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/klaviyo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/sources/linkedin-ads.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
9 changes: 5 additions & 4 deletions docs/integrations/sources/mailchimp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Expand Down
Loading

0 comments on commit 8288c16

Please sign in to comment.