Skip to content

Commit

Permalink
docs: Update homepage and product summary (#45689)
Browse files Browse the repository at this point in the history
  • Loading branch information
nataliekwong authored Sep 23, 2024
1 parent 24050c1 commit ec65718
Show file tree
Hide file tree
Showing 19 changed files with 66 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ The Connection Timeline displays information about several types of relevant con
- Sync
- Refresh
- Clear
- Connector Version changes (coming soon)
- Connection configuration changes
- Schema changes (coming soon)
- Connection configuration changes (coming soon)
- Connector Version changes (coming soon)
- Connector configuration changes (coming soon)

To review the Connection Timeline, click a connection in the list and navigate to the "Timeline" tab to view its event history. The page displays recent events and their statuses. Where relevant, the event will also show the user who took the action.

Expand Down
41 changes: 22 additions & 19 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,41 @@ displayed_sidebar: docs

# Welcome to Airbyte Docs

## What is Airbyte?
<Grid columns="1">

Airbyte is an open-source data movement infrastructure for building extract and load (EL) data pipelines. It is designed for versatility, scalability, and ease-of-use.
<CardWithIcon title="What is Airbyte?" description="Airbyte is an open-source data movement infrastructure for building extract and load (EL) data pipelines. It is designed for versatility, scalability, and ease-of-use." icon="enterprise"/>

There are three major components to know in Airbyte:
</Grid>

1. **The connector catalog**
- **350+ pre-built connectors**: Airbyte’s connector catalog comes “out-of-the-box” with over 350 pre-built connectors. These connectors can be used to start replicating data from a source to a destination in just a few minutes.
- **No-Code Connector Builder**: You can easily extend Airbyte’s functionality to support your custom use cases through tools like the [No-Code Connector Builder](./connector-development/connector-builder-ui/overview).
2. **The platform:** Airbyte’s platform provides all the horizontal services required to configure and scale data movement operations, available as [cloud-managed](https://airbyte.com/product/airbyte-cloud) or [self-managed](https://airbyte.com/product/airbyte-enterprise).
3. **The user interface:** Airbyte features a UI, [**PyAirbyte**](./using-airbyte/pyairbyte/getting-started) (Python library), [**API**](./api-documentation), and [**Terraform Provider**](./terraform-documentation) to integrate with your preferred tooling and approach to infrastructure management.
<Arcade id="8UUaeQOILatZ38Rjh8cs" title="Airbyte Demo: Get Started Creating Connections" paddingBottom="calc(61.416666666666664% + 41px)" />

Airbyte is suitable for a wide range of data integration use cases, including AI data infrastructure and EL(T) workloads. Airbyte is also [embeddable](https://airbyte.com/product/powered-by-airbyte) within your own application or platform to power your product.
### Why Airbyte?

Today, teams and organizations require efficient and timely data access to an ever-growing list of data sources. In-house data pipelines are brittle and costly to build and maintain. Airbyte's unique open-source approach enables your data stack to adapt as your data needs evolve.

- **Wide connector availability:** Airbyte’s connector catalog comes “out-of-the-box” with over 350 pre-built connectors. These connectors can be used to start replicating data from a source to a destination in just a few minutes.
- **Long-tail connector coverage:** You can easily extend Airbyte’s functionality to support your custom use cases through Airbyte's [No-Code Connector Builder](./connector-development/connector-builder-ui/overview).

## Airbyte Demo: Creating Connections
- **Robust platform** provides horizontal scaling required for large-scale data movement operations, available as [Cloud-managed](https://airbyte.com/product/airbyte-cloud) or [Self-managed](https://airbyte.com/product/airbyte-enterprise).

<Arcade id="0k75Pa9c9EvrJb8zFsuU" title="Airbyte Demo: Get Started Creating Connections" paddingBottom="calc(61.416666666666664% + 41px)" />
- **Accessible User Interfaces** through the UI, [**PyAirbyte**](./using-airbyte/pyairbyte/getting-started) (Python library), [**API**](./api-documentation), and [**Terraform Provider**](./terraform-documentation) to integrate with your preferred tooling and approach to infrastructure management.

Airbyte is suitable for a wide range of data integration use cases, including AI data infrastructure and EL(T) workloads. Airbyte is also [embeddable](https://airbyte.com/product/powered-by-airbyte) within your own application or platform to power your product.

## For Airbyte Cloud users

Browse the [connector catalog](./integrations/) to find the connector you want. In case the connector is not yet supported on Airbyte Cloud, consider using [Airbyte Open Source](#for-airbyte-open-source-users).
## Get Started

Next, check out the [step-by-step tutorial](./using-airbyte/getting-started) to sign up for Airbyte Cloud, understand Airbyte [concepts](./using-airbyte/core-concepts), and run your first sync.
<Grid columns="3">

## For Airbyte Open Source users
<CardWithIcon title="Start Syncing Data" description="Deploy locally or sign up for Airbyte Cloud to sync data in minutes" ctaText="Get Started" ctaLink="./using-airbyte/getting-started/" icon="enterprise" />

Browse the [connector catalog](./integrations/) to find the connector you want. If the connector is not yet supported on Airbyte Open Source, [build your own connector](./connector-development/).
<CardWithIcon title="Connector Catalog" description="Browse the extensive Connector Catalog of over 350+ sources and destinations" ctaText="Browse" ctaLink="./integrations/" icon="oss" ctaVariant="secondary" />

Next, check out the [Airbyte Open Source QuickStart](./deploying-airbyte/quickstart). Then learn how to [deploy](./deploying-airbyte/quickstart) and [manage](./operator-guides/upgrading-airbyte) Airbyte Open Source in your cloud infrastructure.
<CardWithIcon title="Connector Development Guide" description="Learn how to build and customize connectors
" ctaText="Learn More" ctaLink="./connector-development/" icon="cloud" ctaVariant="secondary" />

## For Airbyte contributors
</Grid>

To contribute to Airbyte code, connectors, and documentation, refer to our [Contributing Guide](./contributing-to-airbyte/).
<br/><br/>

[![GitHub stars](https://img.shields.io/github/stars/airbytehq/airbyte?style=social&label=Star&maxAge=2592000)](https://GitHub.com/airbytehq/airbyte/stargazers/) [![License](https://img.shields.io/static/v1?label=license&message=MIT&color=brightgreen)](https://github.com/airbytehq/airbyte/tree/a9b1c6c0420550ad5069aca66c295223e0d05e27/LICENSE/README.md) [![License](https://img.shields.io/static/v1?label=license&message=ELv2&color=brightgreen)](https://github.com/airbytehq/airbyte/tree/a9b1c6c0420550ad5069aca66c295223e0d05e27/LICENSE/README.md)
4 changes: 2 additions & 2 deletions docs/release_notes/aug_2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This page includes new features and improvements to the Airbyte Cloud and Airbyt
## ✨ Highlights
Destination S3 ([v1.0.0](https://github.com/airbytehq/airbyte/pull/42409)) was released! Experience faster sync speeds, checkpointing, and modernization to our Destinations V2 framework, along with many bug fixes around Avro and Parquet file formats.

Databricks destination ([v3.1.0[(https://github.com/airbytehq/airbyte/pull/40692)]) was also released with several new features, including typing & deduping, refreshes, and resumable full refresh! We are actively looking for beta testers. Please reach out to us [here](https://github.com/airbytehq/airbyte/discussions/43997) with your feedback.
Databricks destination ([v3.1.0](https://github.com/airbytehq/airbyte/pull/40692)) was also released with several new features, including typing & deduping, refreshes, and resumable full refresh! We are actively looking for beta testers. Please reach out to us [here](https://github.com/airbytehq/airbyte/discussions/43997) with your feedback.


## Platform Releases
Expand All @@ -29,7 +29,7 @@ We also released a few notable improvements for our connectors:

- We now share SBOM for our connectors in our connector registry to enable vulnerability scanning and supply chain attack prevention.

- PyAirbyte now supports writing to destination connectors and the latest version contains significant performance improvements for record processing and Snowflake-based cache loads. . PyAirbyte has been updated to support Python 3.9 in the latest v0.17.0 release. This allows us to move faster by reducing support footprint, and it allows us to keep up with the latest version of the Python CDK.
- PyAirbyte now supports writing to destination connectors and the latest version contains significant performance improvements for record processing and Snowflake-based cache loads. PyAirbyte has been updated to support Python 3.9 in the latest v0.17.0 release. This allows us to move faster by reducing support footprint, and it allows us to keep up with the latest version of the Python CDK.

## Announcements

Expand Down
Binary file removed docs/using-airbyte/assets/enabled-streams.png
Binary file not shown.
Binary file modified docs/using-airbyte/assets/field-selection.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/using-airbyte/assets/refresh-modal.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 added docs/using-airbyte/assets/schema-tab-streams.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/using-airbyte/assets/select-sync-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 10 additions & 12 deletions docs/using-airbyte/configuring-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ To learn more about streams and fields, see our [Core Concepts](/using-airbyte/c

On the "Schema" tab of a connection, you choose which streams to sync and how they are loaded to the destination.

![Enabled Streams](./assets/enabled-streams.png)
![Enabled Streams](./assets/schema-tab-streams.png)

To modify which streams are enabled:

1. In the Airbyte UI, click **Connections** and then click the connection you want to change.

2. Click the **Schema** tab. All the streams Airbyte has discovered from your source will appear.

3. Toggle **Sync** on or off for your selected stream. To select or deselect all streams at once, use the summary toggle in the table header. To select or deselect an individual stream, use the toggle in its row.
3. Toggle the checkbox on or off for your selected stream. To select or deselect all streams at once, use the summary toggle for all the streams in the namespace. Most sources only have one namespace, so the summary toggle will be located in the header. To select or deselect an individual stream, use the toggle in its row.

:::tip
Use the toggle "Hide disabled streams" to quickly view all enabled streams or all disabled streams.
Use the tabs to show only enabled streams or all disabled streams.
:::

## Modify Stream Names
Expand All @@ -33,8 +33,8 @@ By default, Airbyte does not add any text to the **Stream prefix**. Streams with

| Source stream name | Stream Prefix | Destination stream name |
|--|--|--|
| Accounts | | Accounts |
| Accounts | salesforce_ | salesforce_accounts |
| accounts | | accounts |
| accounts | salesforce_ | salesforce_accounts |

Airbyte does not allow for the renaming of individual streams at this time.

Expand All @@ -58,9 +58,9 @@ Cursors and Primary Keys that are defined by the source are automatically select

To modify a cursor or primary key for a stream:

1. Click on a specific stream that is enabled.
1. Click on the toggle for a stream that is enabled to show all it's fields.

2. Select a sync mode specific to the stream.
2. Select the cursor or primary key from the fields displayed.

3. Save your changes. You may need to `Refresh` or `Clear` your data to ensure data continues syncing successfully.

Expand All @@ -80,13 +80,11 @@ When you refresh the schema, newly added fields will be selected by default, eve

To select a partial set of fields:

1. Click on a stream to display the stream details panel. A new pane showing all the fields in the stream will open. You'll see each field we detect from the source.
1. Toggle a stream to display the fields in that stream. The fields will appear nested under the stream name. You'll see each field we detect from the source.

2. Toggle individual fields to include or exclude them in the sync, or use the toggle in the table header to select or deselect all fields at once.
2. Toggle individual fields to include or exclude them in the sync.

5. Click the **X** to close the stream details panel.

6. Click **Save changes**, or click **Cancel** to discard the changes.
3. Click **Save changes**, or click **Cancel** to discard the changes.

7. The **Stream configuration changed** dialog may display. This gives you the option to `Refresh` the edited streams when you save your changes. If your destination does not support `Refreshes`, you will need to `Clear` your data instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-airbyte/getting-started/add-a-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ products: all

Setting up a new source in Airbyte is a quick and simple process! When viewing the Airbyte UI, you'll see the main navigation bar on the left side of your screen. Click the **Sources** tab to bring up a list of all available sources.

<Arcade id="WjbChISa931Hc55yx4cb" title="Getting Started (Source)" paddingBottom="calc(61.42578125% + 41px)" />
<Arcade id="k63e0sDIzPWtM0wQjNSC" title="Getting Started (Source)" paddingBottom="calc(61.42578125% + 41px)" />

You can use the provided search bar, or simply scroll down the list to find the source you want to replicate data from. Let's use a demo source, Faker, as an example. Clicking on the **Sample Data (Faker)** card will bring us to its setup page.

Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 18 additions & 22 deletions docs/using-airbyte/getting-started/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,38 @@
products: all
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Airbyte Overview

Airbyte is an open-source data integration platform designed to help you consolidate data from various sources into your data warehouses, lakes, and databases.

Whether you're part of a large organization managing complex data pipelines or an individual analyst consolidating data for a personal project, Airbyte can work for you! We offer flexibility and scalability that's easy to tailor to your specific needs, from one-off jobs to enterprise-grade solutions.
Whether you're part of a large organization managing complex data pipelines or an individual analyst consolidating data for a personal project, Airbyte can work for you! We offer flexibility and scalability that's easy to tailor to your specific needs, from one-off jobs to enterprise-grade solutions.


There are two options to consider to run Airbyte:
- **Airbyte Cloud** (recommended): allows you to focus on moving data while we take care of managing the infrastructure.
- **Self-Managed Airbyte**: can be deployed either locally or in an infrastructure you've set up. Our Self-Managed solution can be used as a free Community product or implemented with support of Enterprise operations.
## Airbyte Products

:::tip
If you have already deployed Airbyte or you've signed up to use Airbyte Cloud, and you're familiar with [Airbyte's core concepts](../../using-airbyte/core-concepts/), jump ahead to [Building Connections](../../cloud/managing-airbyte-cloud/configuring-connections.md).
:::
<Grid columns="2">

## Airbyte Cloud
<CardWithIcon title="Self-Managed Community (OSS)" description="Deploy locally or in your own infrastructure. Get started immediately without your data leaving your premises." ctaText="OSS Quickstart" ctaLink="oss-quickstart" icon="fa-download" />

To use Airbyte Cloud, [sign up](https://cloud.airbyte.io/signup) with your email address, Google login, or GitHub login. Upon signing up, you'll be taken to your workspace. There, you can collaborate with team members and share resources across your team under a single billing account.
<CardWithIcon title="Cloud" description="A Cloud-native version of Airbyte that provides a fully managed experience for data replication, allowing you to focus on moving data while we take care of managing the infrastructure. Free 14-day trial, no credit card required" ctaText="Sign Up for Cloud" ctaLink="https://cloud.airbyte.com/signup" icon="fa-cloud" />

Airbyte Cloud offers a 14-day free trial that begins after your first successful sync. You can find more details about Airbyte Cloud for practitioners and teams, as well as a tool for evaluating costs on our [pricing page](https://www.airbyte.com/pricing).
</Grid>

To start setting up a data pipeline, see how to [set up a source](./add-a-source.md).
<Grid columns="2">

## Self-Managed Community (OSS)
<CardWithIcon title="Self-Managed Enterprise" description="Highly available, secure data movement for your entire organization. To start with Self-Managed Enterprise, you'll need a license key. For more details, review our Enterprise setup guide. " ctaText="Learn More" ctaLink="../../enterprise-setup" icon="fa-lock" />

When self-managing Airbyte, your data never leaves your premises. You can use our [OSS Quickstart](oss-quickstart.md) to get started immediately by deploying locally using abctl.
<CardWithIcon title="Cloud Teams" description="For organizations
looking to scale efficiently. For more details, talk to our Sales team. " ctaText="Talk to Sales" ctaLink="https://airbyte.com/company/talk-to-sales" icon="fa-lock" />

:::tip
If you're trying Airbyte out for the first time, we'd recommend you sign up for the [Airbyte Cloud trial](https://cloud.airbyte.io/signup) or deploy OSS locally.
:::

To deploy Airbyte in production, Airbyte recommends deploying on [Kubernetes via Helm](../../deploying-airbyte/on-kubernetes-via-helm.md).
</Grid>

## Self-Managed Enterprise

Airbyte Self-Managed Enterprise is the most robust way to run Airbyte yourself. With this option, you'll have access to all 300+ pre-built connectors and data will never need to leave your environment. Enterprise setup means that Airbyte becomes self-serve in your organization with new tools to manage multiple users, and the ability to set up multiple teams using Airbyte all in one place.
## Additional Resources
- [Airbyte's Core Concepts](../../using-airbyte/core-concepts/)
- [Building Connections](../../cloud/managing-airbyte-cloud/configuring-connections.md)

:::tip
To start with Self-Managed Enterprise, you'll need a license key. [Talk to sales](https://airbyte.com/company/talk-to-sales) to get started with Enterprise. For more details, review our [Enterprise setup guide](/enterprise-setup/README.md).
:::
Loading

0 comments on commit ec65718

Please sign in to comment.