Skip to content

Commit

Permalink
GitBook: [no_maintenance_required] 75 pages and 20 assets modified (a…
Browse files Browse the repository at this point in the history
…irbytehq#1291)

Co-authored-by: John Lafleur <[email protected]>
  • Loading branch information
johnlafleur and John Lafleur authored Dec 11, 2020
1 parent 4bc797c commit 2868c4a
Show file tree
Hide file tree
Showing 15 changed files with 14 additions and 10 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ We love contributions to Airbyte, big or small.

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 connectors using the language you want, as Airbyte connections run as Docker containers.**
**Note that you are able to create connectors using the language you want, as Airbyte connections run as Docker containers.**

**Also, we will never ask you to maintain your connector. The goal is that the Airbyte team and the community helps maintain it, let's call it crowdsourced maintenance!**

## Community support

Expand Down
6 changes: 4 additions & 2 deletions docs/contributing-to-airbyte/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ 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.

#### **Contributing sources & destinations:**
* 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 Connectors](building-new-connector/python-connectors.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)

You can build a Source and a Destination in any language. Since we frequently build connectors in Python, on top of Singer or in Java, we've created generator libraries to get you started quickly. See [Building new connectors](building-new-connector/) to get started.
**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.

### **Documentation**

Expand Down
2 changes: 2 additions & 0 deletions docs/contributing-to-airbyte/building-new-connector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ A connector takes the form of a Docker image which follows the [Airbyte specific
We support 2 types of connectors: Sources and Destinations.
To build a new connector, we provide templates so you don't need to start everything from scratch.

**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.

## The Airbyte specification

Before you can start building your own connector, you need to understand [Airbyte's data protocol specification](../../architecture/airbyte-specification.md).
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/sources/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,4 @@ The Jira connector should not run into Jira API limitations under normal usage.
### Setup guide

Please follow the [Jira confluence for generating an API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html).

11 changes: 4 additions & 7 deletions docs/integrations/sources/mixpanel.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

## Overview

The Mixpanel source supports Full Refresh syncs. That is, every time a sync is run,
Airbyte will copy all rows in the tables and columns you set up for replication into the destination in a new table.
The Mixpanel source supports Full Refresh syncs. That is, every time a sync is run, Airbyte will copy all rows in the tables and columns you set up for replication into the destination in a new table.

This Hubspot source wraps the [Singer Mixpanel Tap](https://github.com/singer-io/tap-mixpanel).

Expand All @@ -19,8 +18,7 @@ Several output streams are available from this source:
* [Cohorts](https://developer.mixpanel.com/docs/cohorts#section-list-cohorts)
* [Cohort Members](https://developer.mixpanel.com/docs/data-export-api#section-engage)

If there are more endpoints you'd like Airbyte to support, please
[create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose)
If there are more endpoints you'd like Airbyte to support, please [create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose)

### Features

Expand All @@ -33,9 +31,7 @@ If there are more endpoints you'd like Airbyte to support, please

### Performance considerations

The Mixpanel connector should not run into Mixpanel API limitations under normal usage.
Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate
limit issues that are not automatically retried successfully.
The Mixpanel connector should not run into Mixpanel API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.

## Getting started

Expand All @@ -46,3 +42,4 @@ limit issues that are not automatically retried successfully.
### Setup guide

Please read [Find API Secret](https://help.mixpanel.com/hc/en-us/articles/115004502806-Find-Project-Token-).

0 comments on commit 2868c4a

Please sign in to comment.