diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e5f6e31810ee6..7d0ec94e63928 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,2 +1,2 @@ # Code of conduct -View in [docs.airbyte.io](https://docs.airbyte.io/contributing/contributing-to-airbyte/code-of-conduct) +View in [docs.airbyte.io](https://docs.airbyte.io/contributing-to-airbyte/code-of-conduct) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d392625c66712..85512b1d4afa6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,2 +1,2 @@ # Contributing -View on [docs.airbyte.io](https://docs.airbyte.io/contributing/contributing-to-airbyte) +View on [docs.airbyte.io](https://docs.airbyte.io/contributing-to-airbyte) diff --git a/README.md b/README.md index 4d88deac7b208..72669dfabea15 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,15 @@ ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/airbytehq/airbyte/Airbyte%20CI) ![License](https://img.shields.io/github/license/airbytehq/airbyte) [![StackShare](https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](https://stackshare.io/airbyte/airbyte) -[![](docs/.gitbook/assets/airbyte_white-background%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29.svg)](https://airbyte.io) +[![](docs/.gitbook/assets/airbyte_white-background%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29%20%281%29%20%281%29.svg)](https://airbyte.io) ### Data integration made simple, secure and extensible. The new open-source standard to sync data from applications, APIs & databases to warehouses. -[![](docs/.gitbook/assets/deploy-locally%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29.svg)](https://docs.airbyte.io/deploying-airbyte/on-your-workstation) [![](docs/.gitbook/assets/deploy-on-aws%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29.svg)](https://docs.airbyte.io/deploying-airbyte/on-aws-ec2) [![](docs/.gitbook/assets/deploy-on-gcp%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29.svg)](https://docs.airbyte.io/deploying-airbyte/on-gcp-compute-engine) +[![](docs/.gitbook/assets/deploy-locally%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29%20%281%29%20%281%29.svg)](docs/deploying-airbyte/on-your-workstation.md) [![](docs/.gitbook/assets/deploy-on-aws%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29%20%281%29%20%281%29.svg)](docs/deploying-airbyte/on-aws-ec2.md) [![](docs/.gitbook/assets/deploy-on-gcp%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29%20%281%29%20%281%29.svg)](docs/deploying-airbyte/on-gcp-compute-engine.md) -![](docs/.gitbook/assets/sources_list%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29.png) +![](docs/.gitbook/assets/sources_list%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29%20%281%29%20%281%29.png) Airbyte is on a mission to make data integration pipelines a commodity. @@ -49,7 +49,7 @@ Here is a [step-by-step guide](docs/getting-started-tutorial.md) showing you how We love contributions to Airbyte, big or small. -See our [Contributing guide](https://docs.airbyte.io/contributing/contributing-to-airbyte) on how to get started. Not sure where to start? We’ve listed some [good first issues](https://github.com/airbytehq/airbyte/labels/good%20first%20issue) to start with. You can also [book a free, no-pressure pairing session](https://drift.me/micheltricot/meeting) with one of our core contributors. +See our [Contributing guide](docs/contributing-to-airbyte/) on how to get started. Not sure where to start? We’ve listed some [good first issues](https://github.com/airbytehq/airbyte/labels/good%20first%20issue) to start with. You can also [book a free, no-pressure pairing session](https://drift.me/micheltricot/meeting) with one of our core contributors. **Note that you are able to create integrations using the language you want, as Airbyte connections run as Docker containers.** @@ -64,7 +64,7 @@ For general help using Airbyte, please refer to the official Airbyte documentati ## Roadmap -Check out our [roadmap](https://github.com/airbytehq/airbyte/projects/1) to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature. For our high-level roadmap and strategy, you can check [our handbook](https://docs.airbyte.io/company-handbook/company-handbook/roadmap). +Check out our [roadmap](https://github.com/airbytehq/airbyte/projects/1) to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature. For our high-level roadmap and strategy, you can check [our handbook](docs/company-handbook/roadmap.md). ## License diff --git a/docs/.gitbook/assets/10-000-feet-view (1) (1) (1) (1).png b/docs/.gitbook/assets/10-000-feet-view (1) (1) (1) (1).png new file mode 100644 index 0000000000000..b6f1f635e224f Binary files /dev/null and b/docs/.gitbook/assets/10-000-feet-view (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/airbyte_white-background (1) (1) (1) (1) (2) (1) (1).svg b/docs/.gitbook/assets/airbyte_white-background (1) (1) (1) (1) (2) (1) (1).svg new file mode 100644 index 0000000000000..276d36b71b048 --- /dev/null +++ b/docs/.gitbook/assets/airbyte_white-background (1) (1) (1) (1) (2) (1) (1).svg @@ -0,0 +1,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/.gitbook/assets/airbyte_white-background (1) (1) (1) (1) (2) (1).svg b/docs/.gitbook/assets/airbyte_white-background (1) (1) (1) (1) (2) (1).svg new file mode 100644 index 0000000000000..276d36b71b048 --- /dev/null +++ b/docs/.gitbook/assets/airbyte_white-background (1) (1) (1) (1) (2) (1).svg @@ -0,0 +1,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/.gitbook/assets/aws_ec2_ami (1) (1) (1) (1).png b/docs/.gitbook/assets/aws_ec2_ami (1) (1) (1) (1).png new file mode 100644 index 0000000000000..6bc3f2260e805 Binary files /dev/null and b/docs/.gitbook/assets/aws_ec2_ami (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/aws_ec2_instance_type (1) (1) (1) (1).png b/docs/.gitbook/assets/aws_ec2_instance_type (1) (1) (1) (1).png new file mode 100644 index 0000000000000..c719d46722e7f Binary files /dev/null and b/docs/.gitbook/assets/aws_ec2_instance_type (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/aws_ec2_instance_view (1) (1) (1) (1).png b/docs/.gitbook/assets/aws_ec2_instance_view (1) (1) (1) (1).png new file mode 100644 index 0000000000000..371b0ef5a2dec Binary files /dev/null and b/docs/.gitbook/assets/aws_ec2_instance_view (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/aws_ec2_launch (1) (1) (1) (1).png b/docs/.gitbook/assets/aws_ec2_launch (1) (1) (1) (1).png new file mode 100644 index 0000000000000..259366b620241 Binary files /dev/null and b/docs/.gitbook/assets/aws_ec2_launch (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/aws_ec2_security_group (1) (1) (1) (1).png b/docs/.gitbook/assets/aws_ec2_security_group (1) (1) (1) (1).png new file mode 100644 index 0000000000000..f584064dad2ab Binary files /dev/null and b/docs/.gitbook/assets/aws_ec2_security_group (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/aws_ec2_ssh_key (1) (1) (1) (1).png b/docs/.gitbook/assets/aws_ec2_ssh_key (1) (1) (1) (1).png new file mode 100644 index 0000000000000..1776c280db723 Binary files /dev/null and b/docs/.gitbook/assets/aws_ec2_ssh_key (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/deploy-locally (1) (1) (1) (1) (2) (1) (1).svg b/docs/.gitbook/assets/deploy-locally (1) (1) (1) (1) (2) (1) (1).svg new file mode 100644 index 0000000000000..9540e40bcf13f --- /dev/null +++ b/docs/.gitbook/assets/deploy-locally (1) (1) (1) (1) (2) (1) (1).svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/.gitbook/assets/deploy-locally (1) (1) (1) (1) (2) (1).svg b/docs/.gitbook/assets/deploy-locally (1) (1) (1) (1) (2) (1).svg new file mode 100644 index 0000000000000..9540e40bcf13f --- /dev/null +++ b/docs/.gitbook/assets/deploy-locally (1) (1) (1) (1) (2) (1).svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/.gitbook/assets/deploy-on-aws (1) (1) (1) (1) (2) (1) (1).svg b/docs/.gitbook/assets/deploy-on-aws (1) (1) (1) (1) (2) (1) (1).svg new file mode 100644 index 0000000000000..1b90bdf3a1f8f --- /dev/null +++ b/docs/.gitbook/assets/deploy-on-aws (1) (1) (1) (1) (2) (1) (1).svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/.gitbook/assets/deploy-on-aws (1) (1) (1) (1) (2) (1).svg b/docs/.gitbook/assets/deploy-on-aws (1) (1) (1) (1) (2) (1).svg new file mode 100644 index 0000000000000..1b90bdf3a1f8f --- /dev/null +++ b/docs/.gitbook/assets/deploy-on-aws (1) (1) (1) (1) (2) (1).svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/.gitbook/assets/deploy-on-gcp (1) (1) (1) (1) (2) (1) (1).svg b/docs/.gitbook/assets/deploy-on-gcp (1) (1) (1) (1) (2) (1) (1).svg new file mode 100644 index 0000000000000..620a22bb70a0a --- /dev/null +++ b/docs/.gitbook/assets/deploy-on-gcp (1) (1) (1) (1) (2) (1) (1).svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/.gitbook/assets/deploy-on-gcp (1) (1) (1) (1) (2) (1).svg b/docs/.gitbook/assets/deploy-on-gcp (1) (1) (1) (1) (2) (1).svg new file mode 100644 index 0000000000000..620a22bb70a0a --- /dev/null +++ b/docs/.gitbook/assets/deploy-on-gcp (1) (1) (1) (1) (2) (1).svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/.gitbook/assets/gcp_ce_configure (1) (1) (1) (1).png b/docs/.gitbook/assets/gcp_ce_configure (1) (1) (1) (1).png new file mode 100644 index 0000000000000..5850c00302c05 Binary files /dev/null and b/docs/.gitbook/assets/gcp_ce_configure (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/gcp_ce_launch (1) (1) (1) (1).png b/docs/.gitbook/assets/gcp_ce_launch (1) (1) (1) (1).png new file mode 100644 index 0000000000000..4d6ec00e7f398 Binary files /dev/null and b/docs/.gitbook/assets/gcp_ce_launch (1) (1) (1) (1).png differ diff --git a/docs/.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm (2) (1).png b/docs/.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm (2) (1).png new file mode 100644 index 0000000000000..747fcfaebac3a Binary files /dev/null and b/docs/.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm (2) (1).png differ diff --git a/docs/.gitbook/assets/sources_list (1) (1) (1) (1) (2) (1) (1).png b/docs/.gitbook/assets/sources_list (1) (1) (1) (1) (2) (1) (1).png new file mode 100644 index 0000000000000..a1676deeb6207 Binary files /dev/null and b/docs/.gitbook/assets/sources_list (1) (1) (1) (1) (2) (1) (1).png differ diff --git a/docs/.gitbook/assets/sources_list (1) (1) (1) (1) (2) (1).png b/docs/.gitbook/assets/sources_list (1) (1) (1) (1) (2) (1).png new file mode 100644 index 0000000000000..a1676deeb6207 Binary files /dev/null and b/docs/.gitbook/assets/sources_list (1) (1) (1) (1) (2) (1).png differ diff --git a/docs/architecture/README.md b/docs/architecture/README.md index f334529e7a456..221a7e7cdbc72 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -4,7 +4,7 @@ description: Here is a high level view of Airbyte's components. # Architecture -![3.048-Kilometer view](../.gitbook/assets/10-000-feet-view%20%281%29%20%281%29%20%281%29.png) +![3.048-Kilometer view](../.gitbook/assets/10-000-feet-view%20%281%29%20%281%29%20%281%29%20%281%29.png) * `UI`: Acts as the control center for Airbyte. From the UI, you can configure new integration connections. You can also track the different syncing jobs and view logs. * `Config Store`: Stores all the connections information \(credentials, frequency...\). diff --git a/docs/company-handbook/roadmap.md b/docs/company-handbook/roadmap.md index 017af68269ecf..76a335be91bdf 100644 --- a/docs/company-handbook/roadmap.md +++ b/docs/company-handbook/roadmap.md @@ -2,7 +2,7 @@ You can access our short-term roadmap here on our [Github project](https://github.com/airbytehq/airbyte/projects/1). -You can also see our last release in our [changelog](https://docs.airbyte.io/changelog). We try to have a weekly release cadence. +You can also see our last release in our [changelog](../changelog.md). We try to have a weekly release cadence. We also wanted to share with you how we think about the high-level roadmap over the next few months and years. We foresee several high-level phases that we will try to share here. diff --git a/docs/company-handbook/strategy.md b/docs/company-handbook/strategy.md index db20831a366a8..af994286360c1 100644 --- a/docs/company-handbook/strategy.md +++ b/docs/company-handbook/strategy.md @@ -8,7 +8,7 @@ On top of that, we will build data quality monitoring, privacy compliance \(GDPR Eventually, you should be able to build your own Fivetran platform internally, while having complete control over your data and costs \(not indexed on MTUs\). If any integration that you need is missing, we will make it super easy for you to build it and to use our orchestration and scheduling features for it. -We will stay at parity with the incumbent’s features \(Fivetran, StitchData\) at first - see our [high-level roadmap](https://docs.airbyte.io/company-handbook/company-handbook/roadmap) -, as our differentiation is on: +We will stay at parity with the incumbent’s features \(Fivetran, StitchData\) at first - see our [high-level roadmap](roadmap.md) -, as our differentiation is on: * open source, enabling you to add your own integration very easily * data privacy and control diff --git a/docs/company-handbook/team.md b/docs/company-handbook/team.md index fde056abab0e0..a1d9520a845a5 100644 --- a/docs/company-handbook/team.md +++ b/docs/company-handbook/team.md @@ -3,7 +3,7 @@ ## **Michel Tricot** Michel was a director of engineering and head of integrations at LiveRamp \(NYSE: RAMP\), and founding member at rideOS \(raised $35M\). His expertise includes B2B products, data infrastructure, scale and deep integrations. -[**LinkedIn**](https://www.linkedin.com/in/micheltricot/)\*\*\*\* +[**LinkedIn**](https://www.linkedin.com/in/micheltricot/) **\|** [**Twitter**](https://twitter.com/MichelTricot) ## **John Lafleur** diff --git a/docs/contributing-to-airbyte/README.md b/docs/contributing-to-airbyte/README.md index f04bea61ad0be..4d630c2d631f1 100644 --- a/docs/contributing-to-airbyte/README.md +++ b/docs/contributing-to-airbyte/README.md @@ -8,30 +8,21 @@ Thank you for your interest in contributing! We love community contributions. Co However, for those who want a bit more guidance on the best way to contribute to Airbyte, read on. This document will cover what we're looking for. By addressing the points below, the chances that we can quickly merge or address your contributions will increase. -## Table of Contents +## Code of conduct -1. [Code of conduct](https://docs.airbyte.io/contributing/contributing-to-airbyte/#1-code-of-conduct) -2. [Airbyte specification](https://docs.airbyte.io/contributing/contributing-to-airbyte#2-airbyte-specification) -3. [First-time contributors, welcome!](https://docs.airbyte.io/contributing/contributing-to-airbyte#3-first-time-contributors-welcome) -4. [Areas for contributing](https://docs.airbyte.io/contributing/contributing-to-airbyte#4-areas-for-contributing) -5. [Ways you can contribute](https://docs.airbyte.io/contributing/contributing-to-airbyte#5-ways-you-can-contribute) -6. [Review process](https://docs.airbyte.io/contributing/contributing-to-airbyte#6-review-process) +Please follow our [Code of conduct](code-of-conduct.md) in the context of any contributions made to Airbyte. -## 1. Code of conduct +## Airbyte specification -Please follow our [Code of conduct](https://docs.airbyte.io/contributing/code-of-conduct) in the context of any contributions made to Airbyte. +Before you can start contributing, you need to understand [Airbyte's data protocol specification](../architecture/airbyte-specification.md). -## 2. Airbyte specification - -Before you can start contributing, you need to understand [Airbyte's data protocol specification](https://docs.airbyte.io/architecture/airbyte-specification). - -## 3. First-time contributors, welcome! +## First-time contributors, welcome! We appreciate first time contributors and we are happy to assist you in getting started. In case of questions, just reach out to us via [email](mailto:hey@airbyte.io) or [Slack](https://slack.airbyte.io)! Here is a list of easy [good first issues](https://github.com/airbytehq/airbyte/labels/good%20first%20issue) to do. -## 4. Areas for contributing +## Areas for contributing ### **New integrations** @@ -54,11 +45,11 @@ Our goal is to keep our docs comprehensive and updated. If you would like to hel * Fix errors in existing docs * Help us in adding to the docs -The contributing guide for docs can be found [here](https://docs.airbyte.io/contributing/contributing-to-airbyte/updating-documentation). +The contributing guide for docs can be found [here](updating-documentation.md). ### **Community content** -We welcome contributions as new tutorials / showcases / articles, or to any of the existing guides on our [tutorials page](http://airbyte.io/tutorials): +We welcome contributions as new tutorials / showcases / articles, or to any of the existing guides on our [tutorials page](https://airbyte.io/tutorials): * Fix errors in existing tutorials * Add new tutorials \(please reach out to us if you have ideas to avoid duplicate work\) @@ -68,7 +59,7 @@ We have a repo dedicated to community content. Everything is documented [there]( Feel free to submit a pull request in this repo, if you have something to add even if it's not related to anything mentioned above. -## 5. Ways you can contribute +## Ways you can contribute ### **Adding to the codebase for an integration or issue** @@ -78,7 +69,7 @@ First, a big thank you! A few things to keep in mind when contributing code: * If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also. * Rebase master with your branch before submitting a pull request. -Here are some details about [our review process](./#6-review-process). +Here are some details about [our review process](./#review-process). ### **Upvoting issues, feature and integration requests** @@ -113,7 +104,7 @@ To see what has already been proposed by the community, you can look [here](http Please do not create a public GitHub issue. If you've found a security issue, please email us directly at [security@airbyte.io](mailto:security@airbyte.io) instead of raising an issue. -## **6. Review process** +## **Review process** **‌‌**If you are considering adding to the codebase or contributing a new integration: a big thank you! We sincerely appreciate your help. diff --git a/docs/deploying-airbyte/on-aws-ec2.md b/docs/deploying-airbyte/on-aws-ec2.md index 9e45ad038af7a..9e9cdceaf90b3 100644 --- a/docs/deploying-airbyte/on-aws-ec2.md +++ b/docs/deploying-airbyte/on-aws-ec2.md @@ -8,15 +8,15 @@ The instructions have been tested on `Amazon Linux 2 AMI (HVM)` * Launch a new instance -![](../.gitbook/assets/aws_ec2_launch%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/aws_ec2_launch%20%281%29%20%281%29%20%281%29%20%281%29.png) * Select instance AMI -![](../.gitbook/assets/aws_ec2_ami%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/aws_ec2_ami%20%281%29%20%281%29%20%281%29%20%281%29.png) * Select instance type -![](../.gitbook/assets/aws_ec2_instance_type%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/aws_ec2_instance_type%20%281%29%20%281%29%20%281%29%20%281%29.png) * `Next: Configure Instance Details` * You can tune parameters or keep the defaults @@ -27,18 +27,18 @@ The instructions have been tested on `Amazon Linux 2 AMI (HVM)` * `Next: Configure Security Groups` * We are going to allow network for `ssh` -![](../.gitbook/assets/aws_ec2_security_group%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/aws_ec2_security_group%20%281%29%20%281%29%20%281%29%20%281%29.png) * `Review and Launch` * `Launch` * Create a ssh key so you can connect to the instance * Download the key \(and don't lose it or you won't be able to connect to the instance\) -![](../.gitbook/assets/aws_ec2_ssh_key%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/aws_ec2_ssh_key%20%281%29%20%281%29%20%281%29%20%281%29.png) * `Launch Instances` -![](../.gitbook/assets/aws_ec2_instance_view%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/aws_ec2_instance_view%20%281%29%20%281%29%20%281%29%20%281%29.png) * Wait for the instance to become `Running` diff --git a/docs/deploying-airbyte/on-gcp-compute-engine.md b/docs/deploying-airbyte/on-gcp-compute-engine.md index 76946fa4eaa4e..86861104bc60f 100644 --- a/docs/deploying-airbyte/on-gcp-compute-engine.md +++ b/docs/deploying-airbyte/on-gcp-compute-engine.md @@ -8,11 +8,11 @@ The instructions have been tested on `Debian GNU/Linux 10 (buster)` * Launch a new instance -![](../.gitbook/assets/gcp_ce_launch%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/gcp_ce_launch%20%281%29%20%281%29%20%281%29%20%281%29.png) * Configure new instance -![](../.gitbook/assets/gcp_ce_configure%20%281%29%20%281%29%20%281%29.png) +![](../.gitbook/assets/gcp_ce_configure%20%281%29%20%281%29%20%281%29%20%281%29.png) * `Create` diff --git a/docs/integrations/adding-your-own-connectors.md b/docs/integrations/adding-your-own-connectors.md index 82ba8ab3061f9..3f198fd616a6b 100644 --- a/docs/integrations/adding-your-own-connectors.md +++ b/docs/integrations/adding-your-own-connectors.md @@ -1,20 +1,14 @@ # Custom Connectors -If you'd like to build new connectors and make them part of the pool of pre-built connectors on Airbyte, first a big thank you, and we invite you to check our [contributing guide](https://docs.airbyte.io/contributing/contributing-to-airbyte). +If you'd like to build new connectors and make them part of the pool of pre-built connectors on Airbyte, first a big thank you, and we invite you to check our [contributing guide](../contributing-to-airbyte/). If you'd like to build new connectors, or update existing ones, for your own usage, without contributing to the Airbyte codebase, read along. -## Table of Contents +## The Airbyte specification -1. [Airbyte specification](https://docs.airbyte.io/v/dx-to-add-own-connector_suggestion/integrations/adding-your-own-connectors#1-the-airbyte-specification) -2. [Developing your own connectors](https://docs.airbyte.io/v/dx-to-add-own-connector_suggestion/integrations/adding-your-own-connectors#2-developing-your-own-connectors) -3. [Adding your connectors on our UI to run them](https://docs.airbyte.io/v/dx-to-add-own-connector_suggestion/integrations/adding-your-own-connectors#3-adding-your-connectors-on-our-ui-to-run-them) +Before you can start building your own connector, you need to understand [Airbyte's data protocol specification](../architecture/airbyte-specification.md). -## 1. The Airbyte specification - -Before you can start building your own connector, you need to understand [Airbyte's data protocol specification](https://docs.airbyte.io/architecture/airbyte-specification). - -## 2. Developing your own connectors +## Developing your own connectors It's easy to code your own integrations on Airbyte. Here are some links to instruct on how to code new sources and destinations. @@ -22,13 +16,13 @@ It's easy to code your own integrations on Airbyte. Here are some links to instr While the guides above are specific to the languages used most frequently to write integrations, **Airbyte integrations can be written in any language**. Please reach out to us if you'd like help developing integrations in other languages. -## 3. Adding your connectors in the UI +## Adding your connectors in the UI There are only 3 easy steps to do that: 1.Publish your custom connector onto Dockerhub first \(or any image hub that Airbyte can access\). -2.In the UI, go to the Admin section, and click on \[+ New connector\] on the top right +2.In the UI, go to the Admin section, and click on `[+ New connector]` on the top right ![](https://lh4.googleusercontent.com/8lW_KRkw8w8q96JUJ7Snxj9MRC8toOyd7avLEj9anID53Q7Vj1bkPRSp8skV1VcIJPWsjWugX0pj0jCZ2jdaBwqhZED9E7DN5SRX_FWyRMdQu1eRojCTGm3xW2R8xYC9JE_kQtwn) @@ -40,5 +34,3 @@ Once this is filled, you will see your connector in the UI and your team will be Note that this new connector could just be an updated version of an existing connector that you adapted to your specific edge case. Anything is possible! -### \*\*\*\* - diff --git a/docs/integrations/sources/google-sheets.md b/docs/integrations/sources/google-sheets.md index e8f66e425c908..d4819076a3cf0 100644 --- a/docs/integrations/sources/google-sheets.md +++ b/docs/integrations/sources/google-sheets.md @@ -70,7 +70,7 @@ Once you've created the Service Account, you need to explicitly give it access t Finally, you'll need the ID of the Spreadsheet you'd like to sync. To get it, navigate to the spreadsheet in your browser, then copy the portion of the URL which comes after "/d" and before "/edit" or "/view". This is the highlighted portion of the screenshot below: -![](../../.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm%20%282%29.png) +![](../../.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm%20%282%29%20%281%29.png) ### Setting up in the Airbyte UI