Skip to content

Commit

Permalink
GitBook: [master] 84 pages and 72 assets modified
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcos Marx authored and gitbook-bot committed May 3, 2021
1 parent 9a45f7c commit 7c70eb0
Show file tree
Hide file tree
Showing 130 changed files with 444 additions and 396 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview
# Introduction

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/airbytehq/airbyte/Airbyte%20CI) ![License](https://img.shields.io/github/license/airbytehq/airbyte)

Expand Down Expand Up @@ -32,7 +32,7 @@ docker-compose up

Now visit [http://localhost:8000](http://localhost:8000)

Here is a [step-by-step guide](docs/quickstart/getting-started.md) showing you how to load data from an API into a file, all on your computer.
Here is a [step-by-step guide](https://github.com/airbytehq/airbyte/tree/e378d40236b6a34e1c1cb481c8952735ec687d88/docs/quickstart/getting-started.md) showing you how to load data from an API into a file, all on your computer.

## Features

Expand Down
Binary file removed docs/.gitbook/assets/activate-webhook.png
Binary file not shown.
Binary file removed docs/.gitbook/assets/airbyte-dashboard.png
Binary file not shown.
Binary file removed docs/.gitbook/assets/app-information.png
Binary file not shown.
Binary file removed docs/.gitbook/assets/app-name-modal.png
Binary file not shown.
Binary file removed docs/.gitbook/assets/change-to-date-time.png
Binary file not shown.
Binary file added docs/.gitbook/assets/change-to-per-week (2).png
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/.gitbook/assets/change-to-per-week (3).png
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.
Binary file removed docs/.gitbook/assets/click.png
Binary file not shown.
File renamed without changes
Binary file added docs/.gitbook/assets/datasources (3).png
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/.gitbook/assets/datasources (4).png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.gitbook/assets/destination.png
Binary file not shown.
Binary file removed docs/.gitbook/assets/drag-created-at.png
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.gitbook/assets/empty-meeting-sheet.png
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.gitbook/assets/fill-in-connection-details.png
Binary file not shown.
Binary file not shown.
File renamed without changes
Binary file added docs/.gitbook/assets/launch (2).png
Binary file added docs/.gitbook/assets/launch (3).png
Binary file removed docs/.gitbook/assets/meetings-per-week.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
File renamed without changes
Binary file added docs/.gitbook/assets/schema (2).png
Binary file added docs/.gitbook/assets/schema (3).png
Diff not rendered.
Binary file added docs/.gitbook/assets/setup-successful (2).png
Binary file added docs/.gitbook/assets/setup-successful (3).png
File renamed without changes
Binary file added docs/.gitbook/assets/sync-screen (2).png
Binary file added docs/.gitbook/assets/sync-screen (3).png
Binary file added docs/.gitbook/assets/tableau-dashboard (2).png
Binary file added docs/.gitbook/assets/tableau-dashboard (3).png
Diff not rendered.
Binary file removed docs/.gitbook/assets/view-jwt-token.png
Diff not rendered.
Binary file removed docs/.gitbook/assets/weekly-webinars.png
Diff not rendered.
Binary file removed docs/.gitbook/assets/zoom-dashboard.png
Diff not rendered.
39 changes: 20 additions & 19 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
* [Browsing Output Logs](tutorials/browsing-output-logs.md)
* [Upgrading Airbyte](tutorials/upgrading-airbyte.md)
* [Using the Airflow Airbyte Operator](tutorials/using-the-airflow-airbyte-operator.md)
* [Contributing to Airbyte](contributing-to-airbyte/tutorials/README.md)
* [A Beginner's Guide to the AirbyteCatalog](contributing-to-airbyte/tutorials/beginners-guide-to-catalog.md)
* [Building a Toy Connector](contributing-to-airbyte/tutorials/toy-connector.md)
* [Adding Incremental to a Source](contributing-to-airbyte/tutorials/adding-incremental-sync.md)
* [Building a Python Source](contributing-to-airbyte/tutorials/building-a-python-source.md)
* [Contributing to Airbyte](tutorials/tutorials/README.md)
* [A Beginner's Guide to the AirbyteCatalog](tutorials/tutorials/beginners-guide-to-catalog.md)
* [Building a Toy Connector](tutorials/tutorials/toy-connector.md)
* [Adding Incremental to a Source](tutorials/tutorials/adding-incremental-sync.md)
* [Building a Python Source](tutorials/tutorials/building-a-python-source.md)
* [Transformations and Normalization](tutorials/transformation-and-normalization/README.md)
* [Transformations with SQL \(Part 1/2\)](tutorials/transformation-and-normalization/transformations-with-sql.md)
* [Transformations with DBT \(Part 2/2\)](tutorials/transformation-and-normalization/transformations-with-dbt.md)
Expand Down Expand Up @@ -95,20 +95,20 @@
* [Monorepo Python Development](contributing-to-airbyte/building-new-connector/monorepo-python-development.md)
* [Testing Connectors](contributing-to-airbyte/building-new-connector/testing-connectors.md)
* [Standard Source Test Suite](contributing-to-airbyte/building-new-connector/standard-source-tests.md)
* [Using the Airbyte CDK](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/README.md)
* [Getting Started](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/0-getting-started.md)
* [Step 1: Creating the Source](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/1-creating-the-source.md)
* [Step 2: Install Dependencies](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/2-install-dependencies.md)
* [Step 3: Define Inputs](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/3-define-inputs.md)
* [Step 4: Connection Checking](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/4-connection-checking.md)
* [Step 5: Declare the Schema](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/5-declare-schema.md)
* [Step 6: Read Data](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/6-read-data.md)
* [Step 7: Use the Connector in Airbyte](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/7-use-connector-in-airbyte.md)
* [Step 8: Test Connector](contributing-to-airbyte/tutorials/cdk-tutorial-alpha/8-test-your-connector.md)
* [Using the Airbyte CDK](contributing-to-airbyte/cdk-tutorial-alpha/README.md)
* [Getting Started](contributing-to-airbyte/cdk-tutorial-alpha/0-getting-started.md)
* [Step 1: Creating the Source](contributing-to-airbyte/cdk-tutorial-alpha/1-creating-the-source.md)
* [Step 2: Install Dependencies](contributing-to-airbyte/cdk-tutorial-alpha/2-install-dependencies.md)
* [Step 3: Define Inputs](contributing-to-airbyte/cdk-tutorial-alpha/3-define-inputs.md)
* [Step 4: Connection Checking](contributing-to-airbyte/cdk-tutorial-alpha/4-connection-checking.md)
* [Step 5: Declare the Schema](contributing-to-airbyte/cdk-tutorial-alpha/5-declare-schema.md)
* [Step 6: Read Data](contributing-to-airbyte/cdk-tutorial-alpha/6-read-data.md)
* [Step 7: Use the Connector in Airbyte](contributing-to-airbyte/cdk-tutorial-alpha/7-use-connector-in-airbyte.md)
* [Step 8: Test Connector](contributing-to-airbyte/cdk-tutorial-alpha/8-test-your-connector.md)
* [Code Style](contributing-to-airbyte/code-style.md)
* [Updating Documentation](contributing-to-airbyte/updating-documentation.md)
* [Templates](contributing-to-airbyte/templates/README.md)
* [Connector Doc Template](contributing-to-airbyte/templates/integration-documentation-template.md)
* [Connector Doc Template](contributing-to-airbyte/templates/integration-documentation-template.md)
* [Understanding Airbyte](understanding-airbyte/README.md)
* [AirbyteCatalog & ConfiguredAirbyteCatalog](understanding-airbyte/catalog.md)
* [Airbyte Specification](understanding-airbyte/airbyte-specification.md)
Expand All @@ -121,17 +121,17 @@
* [High-level View](understanding-airbyte/high-level-view.md)
* [Workers & Jobs](understanding-airbyte/jobs.md)
* [Technical Stack](understanding-airbyte/tech-stack.md)
* [Change Data Capture (CDC)](understanding-airbyte/cdc.md)
* [Change Data Capture \(CDC\)](understanding-airbyte/cdc.md)
* [Namespaces](understanding-airbyte/namespaces.md)
* [API documentation](api-documentation.md)
* [API documentation](api-documentation.md)
* [Project Overview](project-overview/README.md)
* [Roadmap](project-overview/roadmap.md)
* [Changelog](project-overview/changelog/README.md)
* [Platform](project-overview/changelog/platform.md)
* [Connectors](project-overview/changelog/connectors.md)
* [License](project-overview/license.md)
* [Careers & Open Positions](career-and-open-positions/README.md)
* [Senior Software Engineer](career-and-open-positions/senior-software-engineer.md)
* [Senior Software Engineer](career-and-open-positions/senior-software-engineer.md)
* [FAQ](faq/README.md)
* [Technical Support](faq/technical-support.md)
* [Getting Started](faq/getting-started.md)
Expand All @@ -144,3 +144,4 @@
* [Singer vs Airbyte](faq/differences-with/singer-vs-airbyte.md)
* [Pipelinewise vs Airbyte](faq/differences-with/pipelinewise-vs-airbyte.md)
* [Meltano vs Airbyte](faq/differences-with/meltano-vs-airbyte.md)

12 changes: 6 additions & 6 deletions docs/career-and-open-positions/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Career & Open Positions
# Careers & Open Positions

## **Who we are**

[Airbyte](http://airbyte.io) is the upcoming open-source standard for EL\(T\). We enable data teams to replicate data from applications, APIs, and databases to data warehouses, lakes, and other destinations. We believe only an open-source approach can solve the problem of data integration, as it enables us to cover the long tail of integrations while enabling teams to adapt prebuilt connectors to their needs.

Airbyte is remote friendly, with most of the team still based in the Silicon Valley. We’re fully open as a company. Our **[company handbook](https://handbook.airbyte.io)**, **[culture & values](https://handbook.airbyte.io/company/culture-and-values)**, **[strategy](https://handbook.airbyte.io/strategy/strategy)** and **[roadmap](../project-overview/roadmap.md)** are open to all.
Airbyte is remote friendly, with most of the team still based in the Silicon Valley. We’re fully open as a company. Our [**company handbook**](https://handbook.airbyte.io), [**culture & values**](https://handbook.airbyte.io/company/culture-and-values), [**strategy**](https://handbook.airbyte.io/strategy/strategy) and [**roadmap**](../project-overview/roadmap.md) are open to all.

We're backed by some of the world's [top investors](./#our-investors) and believe in product-led growth, where we build something awesome and let our product bring the users, rather than an outbound sales engine with cold calls.

Expand Down Expand Up @@ -50,12 +50,12 @@ If the written interview is a success, we might set you up with one or 2 additio

Once all of this done, we will discuss the process internally and get back to you very fast \(velocity is everything here\)! So about 2-3 calls and one written interview, that's it!

## **[Our Benefits](https://handbook.airbyte.io/people/benefits)**
## [**Our Benefits**](https://handbook.airbyte.io/people/benefits)

* **Flexible work environment as fully remote** - we don’t look at when you log in, log out or how much time you work. We trust you, it’s the only way remote can actually work.
* **[Unlimited vacation policy](https://handbook.airbyte.io/people/time-off)** with mandatory minimum time off - so you can fit work around your life.
* **[Co-working space stipend](https://handbook.airbyte.io/people/expense-policy#work-space)** - we provide everyone with $200/month to use on a coworking space of their choice, if any.
* **[Parental leave](https://handbook.airbyte.io/people/time-off#parental-leave)** \(for both parents, after one year spent with the company\) - so those raising families can do so while still working for us.
* [**Unlimited vacation policy**](https://handbook.airbyte.io/people/time-off) with mandatory minimum time off - so you can fit work around your life.
* [**Co-working space stipend**](https://handbook.airbyte.io/people/expense-policy#work-space) - we provide everyone with $200/month to use on a coworking space of their choice, if any.
* [**Parental leave**](https://handbook.airbyte.io/people/time-off#parental-leave) \(for both parents, after one year spent with the company\) - so those raising families can do so while still working for us.
* **Open book policy** - we reimburse books that employees want to purchase for their professional and career development.
* **Continuous learning / training policy** - we sponsor the conferences and training programs you feel would add to your development in the company.
* **Health insurance** for those from countries that do not provide this freely. Through Savvy in the US, which means you can choose the insurance you want and will receive a stipend from the company.
Expand Down
6 changes: 3 additions & 3 deletions docs/career-and-open-positions/senior-software-engineer.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ Wherever you want!
## **Perks!!!**

* **Flexible work environment as fully remote** - we don’t look at when you log in, log out or how much time you work. We trust you, it’s the only way remote can actually work.
* **[Unlimited vacation policy](https://handbook.airbyte.io/people/time-off)** with mandatory minimum time off - so you can fit work around your life.
* **[Co-working space stipend](https://handbook.airbyte.io/people/expense-policy#work-space)** - we provide everyone with $200/month to use on a coworking space of their choice, if any.
* **[Parental leave](https://handbook.airbyte.io/people/time-off#parental-leave)** \(for both parents, after one year spent with the company\) - so those raising families can do so while still working for us.
* [**Unlimited vacation policy**](https://handbook.airbyte.io/people/time-off) with mandatory minimum time off - so you can fit work around your life.
* [**Co-working space stipend**](https://handbook.airbyte.io/people/expense-policy#work-space) - we provide everyone with $200/month to use on a coworking space of their choice, if any.
* [**Parental leave**](https://handbook.airbyte.io/people/time-off#parental-leave) \(for both parents, after one year spent with the company\) - so those raising families can do so while still working for us.
* **Open book policy** - we reimburse books that employees want to purchase for their professional and career development.
* **Continuous learning / training policy** - we sponsor the conferences and training programs you feel would add to your development in the company.
* **Health insurance** for those from countries that do not provide this freely. Through Savvy in the US, which means you can choose the insurance you want and will receive a stipend from the company.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-to-airbyte/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is a list of easy [good first issues](https://github.com/airbytehq/airbyte/
It's easy to add your own connector to Airbyte! **Since Airbyte connectors are encapsulated within Docker containers, you can use any language you like.** Here are some links on how to add sources and destinations. We haven't built the documentation for all languages yet, so don't hesitate to reach out to us if you'd like help developing connectors in other languages.

* See [Building new connectors](building-new-connector/) to get started.
* Since we frequently build connectors in Python, on top of Singer or in Java, we've created generator libraries to get you started quickly: [Build Python Source Connectors](tutorials/building-a-python-source.md) and [Build Java Connectors](building-new-connector/java-connectors.md)
* Since we frequently build connectors in Python, on top of Singer or in Java, we've created generator libraries to get you started quickly: [Build Python Source Connectors](../tutorials/tutorials/building-a-python-source.md) and [Build Java Connectors](building-new-connector/java-connectors.md)
* Integration tests \(tests that run a connector's image against an external resource\) can be run one of three ways, as detailed [here](building-new-connector/testing-connectors.md)

**Please note that, at no point in time, we will ask you to maintain your connector.** The goal is that the Airbyte team and the community helps maintain the connector.
Expand Down
8 changes: 4 additions & 4 deletions docs/contributing-to-airbyte/building-new-connector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ npm run generate

and choose the relevant template. This will generate a new connector in the `airbyte-integrations/connectors/<your-connector>` directory.

Search the generated directory for "TODO"s and follow them to implement your connector.
Search the generated directory for "TODO"s and follow them to implement your connector.

If you are developing a Python connector, you may find the [building a Python connector tutorial](../tutorials/building-a-python-source.md) helpful.
If you are developing a Python connector, you may find the [building a Python connector tutorial](../../tutorials/tutorials/building-a-python-source.md) helpful.

### 2. Integration tests

Expand All @@ -54,14 +54,14 @@ At a minimum, your connector must implement the standard tests described in [Tes

If you're writing in Python or Java, skip this section -- it is provided automatically.

If you're writing in another language, please document the commands needed to:
If you're writing in another language, please document the commands needed to:

1. Build your connector docker image \(usually this is just `docker build .` but let us know if there are necessary flags, gotchas, etc..\)
2. Run any unit or integration tests _in a Docker image_.

Your integration and unit tests must be runnable entirely within a Docker image. This is important to guarantee consistent build environments.

When you submit a PR to Airbyte with your connector, the reviewer will use the commands you provide to integrate your connector into Airbyte's build system as follows:
When you submit a PR to Airbyte with your connector, the reviewer will use the commands you provide to integrate your connector into Airbyte's build system as follows:

1. `:airbyte-integrations:connectors:source-<name>:build` should run unit tests and build the integration's Docker image
2. `:airbyte-integrations:connectors:source-<name>:integrationTest` should run integration tests including Airbyte's Standard test suite.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This guide contains instructions on how to setup Python with Gradle within the A

## Python Connector Development

Before working with connectors written in Python, we recommend running `./gradlew :airbyte-integrations:connectors:<connector directory name>:build` (e.g. `./gradlew :airbyte-integrations:connectors:source-postgres:build`) from the root project directory. This will create a `virtualenv` and install dependencies for the connector you want to work on as well as any internal Airbyte python packages it depends on.
Before working with connectors written in Python, we recommend running `./gradlew :airbyte-integrations:connectors:<connector directory name>:build` \(e.g. `./gradlew :airbyte-integrations:connectors:source-postgres:build`\) from the root project directory. This will create a `virtualenv` and install dependencies for the connector you want to work on as well as any internal Airbyte python packages it depends on.

When iterating on a single connector, you will often iterate by running

Expand Down

0 comments on commit 7c70eb0

Please sign in to comment.