Skip to content

Commit

Permalink
Fixed formatting (#12113)
Browse files Browse the repository at this point in the history
  • Loading branch information
Amruta-Ranade authored Apr 18, 2022
1 parent 6e075d1 commit 2baa170
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 28 deletions.
8 changes: 0 additions & 8 deletions docs/cloud/core-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Airbyte enables you to build data pipelines and replicate data from a source to

This page describes the concepts you need to know to use Airbyte.


## Source

A source is an API, file, database, or data warehouse that you want to ingest data from.
Expand All @@ -17,14 +16,12 @@ A destination is a data warehouse, data lake, database, or an analytics tool whe

An Airbyte component which pulls data from, or pushes data to, a source or destination.


## Connection

A connection is an automated data pipeline that replicates data from a source to a destination.

Setting up a connection involves configuring the following parameters:


<table>
<tr>
<td><strong>Parameter</strong>
Expand Down Expand Up @@ -64,8 +61,6 @@ Setting up a connection involves configuring the following parameters:
</tr>
</table>



## Stream

A stream is a group of related records.
Expand Down Expand Up @@ -154,21 +149,18 @@ After a sync is complete, Airbyte normalizes the data. When setting up a connect

*Note: Custom normalization through dbt is not yet available for Airbyte Cloud.*


## Workspace

A workspace is a grouping of sources, destinations, connections, and other configurations. It lets you collaborate with team members and share resources across your team under a shared billing account.

When you [sign up](http://cloud.airbyte.io/signup) for Airbyte Cloud, we automatically create your first workspace where you are the only user with access. You can set up your sources and destinations to start syncing data and invite other users to join your workspace.


## Credits

An Airbyte credit is a unit of measure used to pay for Airbyte resources when you run a sync.

What one credit stands for depends on the source type:


<table>
<tr>
<td><strong>Source type</strong>
Expand Down
42 changes: 30 additions & 12 deletions docs/cloud/getting-started-with-airbyte-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,22 @@ This page guides you through setting up your Airbyte Cloud account, setting up a
To use Airbyte Cloud:

1. If you haven't already, [sign up for Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=SetupGuide).
<br/> *Note: Airbyte Cloud offers a 14-day free trial with $1000 worth of [credits](https://docs.airbyte.com/getting-started-with-airbyte-cloud/core-concepts#credits), whichever expires first. For more information, see [Pricing](https://airbyte.com/pricing).*

Airbyte Cloud offers a 14-day free trial with $1000 worth of [credits](https://docs.airbyte.com/getting-started-with-airbyte-cloud/core-concepts#credits), whichever expires first. For more information, see [Pricing](https://airbyte.com/pricing).

2. Airbyte will send you an email with a verification link. On clicking the link, you'll be taken to your new workspace.
<br/>*A workspace lets you collaborate with team members and share resources across your team under a shared billing account.*

:::info
A workspace lets you collaborate with team members and share resources across your team under a shared billing account.
:::

You will be greeted with an onboarding tutorial to help you set up your first connection. If you haven’t set up a connection on Airbyte Cloud before, we highly recommend following the tutorial. If you are familiar with the connection setup process, click **Skip onboarding** and follow this guide to set up your next connection.

## Set up a source

*A source is an API, file, database, or data warehouse that you want to ingest data from.*
:::info
A source is an API, file, database, or data warehouse that you want to ingest data from.
:::

To set up a source:

Expand All @@ -25,12 +31,14 @@ To set up a source:
3. On the Set up the source page, enter a name for your source.
4. From the Source type dropdown, select the source you want to set up.
5. The fields relevant to your source are displayed.
<br/> Click **Setup Guide** for help with filling in the fields for your selected source.
Click **Setup Guide** for help with filling in the fields for your selected source.
6. Click **Set up source**.

## Set up a destination

*A destination is a data warehouse, data lake, database, or an analytics tool where you want to load your extracted data.*
:::info
A destination is a data warehouse, data lake, database, or an analytics tool where you want to load your extracted data.
:::

To set up a destination:

Expand All @@ -39,12 +47,14 @@ To set up a destination:
3. On the Set up the destination page, enter a name for your destination.
4. From the Destination type dropdown, select the destination you want to set up.
5. The fields relevant to your destination are displayed.
<br/> Click **Setup Guide** for help with filling in the fields for your selected destination.
Click **Setup Guide** for help with filling in the fields for your selected destination.
6. Click **Set up destination**.

## Set up a connection

*A connection is an automated data pipeline that replicates data from a source to a destination.*
:::info
A connection is an automated data pipeline that replicates data from a source to a destination.
:::

Setting up a connection involves configuring the following parameters:

Expand Down Expand Up @@ -96,13 +106,18 @@ To set up a connection:
2. In the top right corner, click **+ new connection**.
3. On the New Connection page, select a source:
- To use an existing source, select your desired source from the Source dropdown. Click **Use existing source**.

- To set up a new source, enter a name for the new source and select the source from the Source type dropdown. The fields relevant to your source are displayed. Click **Setup Guide** for help with filling in the fields for your selected source. Click **Set up source**.

4. Select a destination:
- To use an existing destination, select your desired destination from the Destination dropdown. Click **Use existing destination**.
- To set up a new destination, enter a name for the new destination and select the destination from the Destination type dropdown. The fields relevant to your destination are displayed. Click **Setup Guide** for help with filling in the fields for your selected source. Click **Set up destination**.
<br/> The Set up the connection page is displayed.

The Set up the connection page is displayed.
5. From the **Replication frequency** dropdown, select how often you want the data to sync from the source to the destination.
<br/>_Note: The default replication frequency is 24 hours._

**Note:** The default replication frequency is 24 hours.

6. From the **Destination Namespace** dropdown, select the format in which you want the data to stored in the destination:

<table>
Expand Down Expand Up @@ -133,7 +148,9 @@ To set up a connection:
</table>


To better understand the destination namespace configurations, see [Destination Namespace example](https://docs.airbyte.com/understanding-airbyte/namespaces#examples)
:::tip
To better understand the destination namespace configurations, see [Destination Namespace example](https://docs.airbyte.com/understanding-airbyte/namespaces#examples)
:::

7. (Optional) In the **Destination Stream Prefix (Optional)** field, add a prefix to stream names (for example, adding a prefix `airbyte_` renames `projects` to `airbyte_projects`).
8. (Optional) Click **Refresh schema** if you had previously triggered a sync with a subset of tables in the stream and now want to see all the tables in the stream.
Expand All @@ -156,9 +173,10 @@ To set up a connection:

* Select **Overwrite** to erase the old data and replace it completely
* Select **Append** to capture changes to your table
<br/> *Note: This creates duplicate records*

**Note:** This creates duplicate records
* Select **Deduped + History** to mirror your source while keeping records unique
<br/> *Note: Some sync modes may not yet be available for your source or destination*
**Note:** Some sync modes may not yet be available for your source or destination

4. **Cursor field**: Used in incremental sync mode to determine which records to sync. Airbyte pre-selects the Cursor field for you (example: updated date). If you have multiple cursor fields, select the one you want.
5. **Primary key**: Used in Deduped and History modes to determine the unique identifier.
Expand Down
9 changes: 7 additions & 2 deletions docs/cloud/managing-airbyte-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ This page will help you manage your Airbyte Cloud workspaces and understand Airb

An Airbyte Workspace allows you to collaborate with other users and manage connections under a shared billing account.

*Note: Airbyte [credits](https://airbyte.com/pricing) are assigned per workspace and cannot be transferred between workspaces.*
:::info
Airbyte [credits](https://airbyte.com/pricing) are assigned per workspace and cannot be transferred between workspaces.
:::

### Add users to your workspace

Expand All @@ -16,7 +18,10 @@ To add a user to your workspace:
2. In the Workspace Settings sidebar, click **Access Management**.
3. In the top right-hand corner, click **+ New User**.
4. On the Add new users window, enter the email address of the user you want to invite to your workspace. Click **Send invitation**.
<br/> *Note: The user will have access to only the workspace you invited them to. Also note that they will be added as a workspace admin by default.*

:::info
The user will have access to only the workspace you invited them to. Also note that they will be added as a workspace admin by default.
:::

### Switch between multiple workspaces

Expand Down
6 changes: 5 additions & 1 deletion docs/integrations/sources/facebook-marketing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ To set up Facebook Marketing as a source in Airbyte Cloud:
6. For **End Date**, enter the date in YYYY-MM-DDTHR:MIN:S format. The data added on and before this date will be replicated. If this field is blank, Airbyte will replicate the latest data.
7. For Account ID, enter your [Facebook Ad Account ID Number](https://www.facebook.com/business/help/1492627900875762).
8. (Optional) Toggle the **Include Deleted** button to include data from deleted Campaigns, Ads, and AdSets.
<br/> **_What does this mean?_** The Facebook Marketing API doesn’t have a concept of deleting records in the same way that a database does. While you can archive or delete an ad campaign, the API maintains a record of the campaign. Toggling the **Include Deleted** button lets you replicate records for campaigns or ads even if they were archived or deleted from the Facebook platform.

:::info
The Facebook Marketing API doesn’t have a concept of deleting records in the same way that a database does. While you can archive or delete an ad campaign, the API maintains a record of the campaign. Toggling the **Include Deleted** button lets you replicate records for campaigns or ads even if they were archived or deleted from the Facebook platform.
:::

9. (Optional) Toggle the **Fetch Thumbnail Images** button to fetch the `thumbnail_url` and store the result in `thumbnail_data_url` for each [Ad Creative](https://developers.facebook.com/docs/marketing-api/creative/).
10. (Optional) In the Custom Insights section, click **Add**.
To retrieve specific fields from Facebook Ads Insights combined with other breakdowns, you can choose which fields and breakdowns to sync.
Expand Down
6 changes: 4 additions & 2 deletions docs/project-overview/licenses/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ The license for a particular work is defined with following prioritized rules:
3. First LICENSE found when exploring parent directories up to the project top level directory
4. Defaults to Elastic License 2.0

If you have any question regarding licenses, just visit our [FAQ](./project-overview/licenses/license-faq) or [contact us](mailto:license@airbyte.io).
If you have any question regarding licenses, just visit our [FAQ](license-faq.md) or [contact us](mailto:license@airbyte.io).

If you want to see a list of examples supported by ELv2, and not, to have a better understanding whether you should be concerned or not, check the [examples](./project-overview/licenses/examples). TL;DR unless you want to host Airbyte yourself and sell it as an ELT/ETL tool, or to sell a product that directly exposes Airbyte’s UI or API, you should be good to go!
If you want to see a list of examples supported by ELv2, and not, to have a better understanding whether you should be concerned or not, check the [examples](examples.md).

**TL;DR:** Unless you want to host Airbyte yourself and sell it as an ELT/ETL tool, or to sell a product that directly exposes Airbyte’s UI or API, you should be good to go!


6 changes: 3 additions & 3 deletions docs/project-overview/licenses/license-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@

## About Elastic License 2.0 (ELv2)
ELv2 is a simple, non-copyleft license, allowing for the right to “use, copy, distribute, make available, and prepare derivative works of the software”. Anyone can use Airbyte, free of charge. You can run the software at scale on your infrastructure. There are only three high-level limitations. You cannot:
1. Provide the products to others as a managed service ([read more](./license-faq#what-is-the-managed-service-use-case-that-is-not-allowed-under-elv2));
1. Provide the products to others as a managed service ([read more](license-faq#what-is-the-managed-service-use-case-that-is-not-allowed-under-elv2));
2. Circumvent the license key functionality or remove/obscure features protected by license keys; or
3. Remove or obscure any licensing, copyright, or other notices.

In case you want to work with Airbyte without these limitations, we offer alternative licenses. These licenses include maintenance, support, and customary commercial terms. If you need a different license, please get in touch with us at: contact@airbyte.io.

[View License](../project-overview/licenses/elv2-license)
[View License](elv2-license.md)

## FAQ
### What limitations does ELv2 impose on my use of Airbyte?
Expand All @@ -26,7 +26,7 @@ If you are an Airbyte Cloud customer, nothing changes for you.
For open-source users, everyone can continue to use Airbyte as they are doing today: no limitations on volume, number of users, number of connections…

There are only a few high-level limitations. You cannot:
1. Provide the products to others as a managed service. For example, you cannot sell a cloud service that provides users with direct access to Airbyte. You can sell access to applications built and run using Airbyte ([read more](./license-faq#what-is-the-managed-service-use-case-that-is-not-allowed-under-elv2)).
1. Provide the products to others as a managed service. For example, you cannot sell a cloud service that provides users with direct access to Airbyte. You can sell access to applications built and run using Airbyte ([read more](license-faq#what-is-the-managed-service-use-case-that-is-not-allowed-under-elv2)).
2. Circumvent the license key functionality or remove/obscure features protected by license keys. For example, our code may contain watermarks or keys to unlock proprietary functionality. Those elements of our code will be marked in our source code. You can’t remove or change them.

### Why did Airbyte adopt ELv2?
Expand Down

0 comments on commit 2baa170

Please sign in to comment.