diff --git a/README.md b/README.md index 9ca3b1c1025..7b166e30d80 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/airbytehq/airbyte/Airbyte%20CI) ![License](https://img.shields.io/github/license/airbytehq/airbyte) -![](docs/.gitbook/assets/airbyte_horizontal_dark%20%281%29%20%281%29%20%282%29%20%281%29.svg) +![](docs/.gitbook/assets/airbyte_horizontal_color_white-background.svg) **Data integration made simple, secure and extensible.** diff --git a/docs/.gitbook/assets/airbyte_horizontal_color_white-background.svg b/docs/.gitbook/assets/airbyte_horizontal_color_white-background.svg new file mode 100644 index 00000000000..5fb85e5083f --- /dev/null +++ b/docs/.gitbook/assets/airbyte_horizontal_color_white-background.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/docs/.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm (1) (1) (1) (1) (1) (2) (1).png b/docs/.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm (1) (1) (1) (1) (1) (2) (1).png new file mode 100644 index 00000000000..747fcfaebac Binary files /dev/null and b/docs/.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm (1) (1) (1) (1) (1) (2) (1).png differ diff --git a/docs/architecture/airbyte-specification.md b/docs/architecture/airbyte-specification.md index 94906bbe899..e699b40064a 100644 --- a/docs/architecture/airbyte-specification.md +++ b/docs/architecture/airbyte-specification.md @@ -162,10 +162,10 @@ read(Config, AirbyteCatalog, State) -> Stream } ``` -Airbyte only supports stream and field names which are alphanumeric or contain underscores, as identified by the regex `[a-zA-Z0-9_]*"`. Syncs may fail -if they attempt to sync streams or fields whose names contain disallowed characters. +Airbyte only supports stream and field names which are alphanumeric or contain underscores, as identified by the regex `[a-zA-Z0-9_]*"`. Syncs may fail if they attempt to sync streams or fields whose names contain disallowed characters. #### Read + * Input: 1. `config` - A configuration JSON object that has been validated using the `ConnectorSpecification`. 2. `catalog` - An `AirbyteCatalog`. This `catalog` should be a subset of the `catalog` returned by the `discover` command. It is what will be used in the `read` command to select what data to transfer. diff --git a/docs/architecture/basic-normalization.md b/docs/architecture/basic-normalization.md index 7179b3ded4b..4ca475a4ea8 100644 --- a/docs/architecture/basic-normalization.md +++ b/docs/architecture/basic-normalization.md @@ -171,4 +171,6 @@ CREATE TABLE "powertrain_specs" ( ``` ### Limitations + Basic Normalization currently only works with streams that contain fewer than 100 fields. + diff --git a/docs/contributing-to-airbyte/developing-locally.md b/docs/contributing-to-airbyte/developing-locally.md index 48d0945ca06..864bdd4fc4a 100644 --- a/docs/contributing-to-airbyte/developing-locally.md +++ b/docs/contributing-to-airbyte/developing-locally.md @@ -116,19 +116,25 @@ docker-compose stop scheduler ### Resetting the Airbyte developer environment -Sometimes you'll want to reset the data in your local environment. One common case for this is if you are updating an connector's entry in the database (`airbyte-config/init/src/main/resources/config`), often the easiest thing to do, is wipe the local database and start it from scratch. To reset your data back to a clean install of Airbyte, follow these steps: +Sometimes you'll want to reset the data in your local environment. One common case for this is if you are updating an connector's entry in the database \(`airbyte-config/init/src/main/resources/config`\), often the easiest thing to do, is wipe the local database and start it from scratch. To reset your data back to a clean install of Airbyte, follow these steps: * Delete the datastore volumes in docker - ```bash + + ```bash docker-compose --env-file .env.dev -f docker-compose.yaml -f docker-compose.dev.yaml down -v - ``` + ``` + * Remove the data on disk - ```bash + + ```bash rm -rf /tmp/dev_root rm -rf /tmp/airbyte_local - ``` -* Rebuild the project - ```bash - ./gradlew build - docker-compose --env-file .env.dev -f docker-compose.yaml -f docker-compose.dev.yaml up -V - ``` + ``` + +* Rebuild the project + + ```bash + ./gradlew build + docker-compose --env-file .env.dev -f docker-compose.yaml -f docker-compose.dev.yaml up -V + ``` + diff --git a/docs/integrations/sources/google-sheets.md b/docs/integrations/sources/google-sheets.md index b4e364be001..5cdb28083b3 100644 --- a/docs/integrations/sources/google-sheets.md +++ b/docs/integrations/sources/google-sheets.md @@ -10,7 +10,7 @@ Each sheet in the selected spreadsheet will be output as a separate stream. Each Airbyte only supports replicating Grid sheets. See the [Google Sheets API docs](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetType) for more info on all available sheet types. -**Note: Sheet names and column headers must contain only alphanumeric characters or `_`, as specified in the [Airbyte Protocol](../../architecture/airbyte-specification.md)**. If your sheet or column header is named e.g: "the data", you'll need to change it to "the_data" for it to be synced by Airbyte. This restriction does not apply to non-header cell values: those can contain any unicode characters. This limitation is temporary and future versions of Airbyte will support more permissive naming patterns. +**Note: Sheet names and column headers must contain only alphanumeric characters or `_`, as specified in the** [**Airbyte Protocol**](../../architecture/airbyte-specification.md). If your sheet or column header is named e.g: "the data", you'll need to change it to "the\_data" for it to be synced by Airbyte. This restriction does not apply to non-header cell values: those can contain any unicode characters. This limitation is temporary and future versions of Airbyte will support more permissive naming patterns. ### Data type mapping @@ -74,7 +74,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%281%29%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29.png) +![](../../.gitbook/assets/screen-shot-2020-10-30-at-2.44.55-pm%20%281%29%20%281%29%20%281%29%20%281%29%20%281%29%20%282%29%20%281%29.png) ### Setting up in the Airbyte UI @@ -82,3 +82,4 @@ The Airbyte UI will ask for two things: 1. The spreadsheet ID 2. The content of the credentials JSON you created in the "Create a Service Account and Service Account Key" step above. This should be as simple as opening the file and copy-pasting all its contents into this field in the Airbyte UI. +