From f22e768316706827584de9eb75187d46dee47a4c Mon Sep 17 00:00:00 2001 From: johnlafleur <68561602+johnlafleur@users.noreply.github.com> Date: Tue, 22 Sep 2020 10:08:16 +1100 Subject: [PATCH] GitBook: [john_09/21/20] 9 pages and 14 assets modified (#359) --- README.md | 1 + docs/SUMMARY.md | 2 +- docs/architecture/high-level-overview.md | 2 +- .../integration-documentation-template.md | 4 +- .../source-template.md | 55 ------------------- ...ntation-1.md => updating-documentation.md} | 0 6 files changed, 5 insertions(+), 59 deletions(-) delete mode 100644 docs/contributing/contributing-to-airbyte/documentation-templates/source-template.md rename docs/contributing/contributing-to-airbyte/{updating-documentation-1.md => updating-documentation.md} (100%) diff --git a/README.md b/README.md index 4891896777af..b16fa4298b36 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,7 @@ For general help using Airbyte, please refer to the official Airbyte documentati * [Slack](https://slack.airbyte.io) \(For live discussion with the Community and Airbyte team\) * [GitHub](https://github.com/airbytehq/airbyte) \(Bug reports, Contributions\) * [Twitter](https://twitter.com/airbytehq) \(Get the news fast\) +* [Weekly office hours](https://airbyte.io/weekly-office-hours/) \(Live informal 30-minute video call sessions with the Airbyte team\) ## Roadmap diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 1bb57aa17ad2..4c09ffbe2ba6 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -24,7 +24,7 @@ * [Contributing to Airbyte](contributing/contributing-to-airbyte/README.md) * [Developing Locally](contributing/contributing-to-airbyte/developing-locally.md) * [Code Style](contributing/contributing-to-airbyte/code-style.md) - * [Updating Documentation](contributing/contributing-to-airbyte/updating-documentation-1.md) + * [Updating Documentation](contributing/contributing-to-airbyte/updating-documentation.md) * [Documentation Templates](contributing/contributing-to-airbyte/documentation-templates/README.md) * [Integration Doc Template](contributing/contributing-to-airbyte/documentation-templates/integration-documentation-template.md) * [Code of Conduct](contributing/code-of-conduct.md) diff --git a/docs/architecture/high-level-overview.md b/docs/architecture/high-level-overview.md index 757fc6231f90..5a7eee839a19 100644 --- a/docs/architecture/high-level-overview.md +++ b/docs/architecture/high-level-overview.md @@ -2,7 +2,7 @@ Here is a high level view of Airbyte's components: -![3.048-Kilometer view](../.gitbook/assets/10-000-feet-view%20%282%29.png) +![3.048-Kilometer view](../.gitbook/assets/10-000-feet-view%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/contributing/contributing-to-airbyte/documentation-templates/integration-documentation-template.md b/docs/contributing/contributing-to-airbyte/documentation-templates/integration-documentation-template.md index 1eeb9d181341..c131687ea7e0 100644 --- a/docs/contributing/contributing-to-airbyte/documentation-templates/integration-documentation-template.md +++ b/docs/contributing/contributing-to-airbyte/documentation-templates/integration-documentation-template.md @@ -4,7 +4,7 @@ description: >- integration. --- -# Integration Doc Template +# Integration documentation template ## Sync overview @@ -38,7 +38,7 @@ This section should contain a table with the following format: ### Performance considerations -Could this connector hurt the user's database/API/etc.. or put too much strain on it in certain circumstances? For example, if there are a lot of tables or rows in a table? What is the breaking point \(e.g: 100mm> records\)? What can the user do to prevent this? \(e.g: use a read-only replica, or schedule frequent syncs, etc..\) +Could this connector hurt the user's database/API/etc... or put too much strain on it in certain circumstances? For example, if there are a lot of tables or rows in a table? What is the breaking point \(e.g: 100mm> records\)? What can the user do to prevent this? \(e.g: use a read-only replica, or schedule frequent syncs, etc..\) ## Getting started diff --git a/docs/contributing/contributing-to-airbyte/documentation-templates/source-template.md b/docs/contributing/contributing-to-airbyte/documentation-templates/source-template.md deleted file mode 100644 index b6da88f3b3c9..000000000000 --- a/docs/contributing/contributing-to-airbyte/documentation-templates/source-template.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: >- - This is the template that should be used when adding documentation for a new - integration. ---- - -# Integration Documentation Template - -## Sync overview - -### Output schema - -Is the output schema fixed \(e.g: for an API like Stripe\)? If so, point to the integration’s schema \(e.g: link to Stripe’s documentation\) or describe the schema here directly \(e.g: include a diagram or paragraphs describing the schema\). - -Describe how the integration's schema is mapped to Airbyte concepts. An example description might be: “MagicDB tables become Airbyte Streams and MagicDB columns become Airbyte Fields. In addition, an extracted\_at column is appended to each row being read.” - -### Data type mapping - -This section should contain a table mapping each of the integration's data types to Airbyte types. At the moment, Airbyte uses the same types used by [JSONSchema](https://json-schema.org/understanding-json-schema/reference/index.html). `string`, `date-time`, `object`, `array`, `boolean`, `integer`, and `number` are the most commonly used data types. - -| Integration Type | Airbyte Type | Notes | -| :--- | :--- | :--- | - -### Features - -This section should contain a table with the following format: - -| Feature | Supported?\(Yes/No\) | Notes | -| :--- | :--- | :--- | -| Full Refresh Sync | | | -| Incremental Sync | | | -| Replicate deletes | | | -| For databases, WAL/Logical replication | | | -| SSL connection | | | -| SSH Tunnel Support | | | -| \(Any other source-specific features\) | | | - -### Performance considerations - -Could this connector hurt the user's database/API/etc.. or put too much strain on it in certain circumstances? For example, if there are a lot of tables or rows in a table? What is the breaking point \(e.g: 100mm> records\)? What can the user do to prevent this? \(e.g: use a read-only replica, or schedule frequent syncs, etc..\) - -## Getting started - -### Requirements - -* What versions of this integration does this implementation support? \(e.g: `postgres v3.14 and above`\) -* What configurations, if any, are required on the integration? \(e.g: `buffer_size > 1024`\) -* Network accessibility requirements -* Credentials/authentication requirements? \(e.g: A DB user with read permissions on certain tables\) - -### Setup guide - -For each of the above high-level requirements as appropriate, add or point to a follow-along guide. See existing source or destination guides for an example. - -For each major cloud provider we support, also add a follow-along guide for setting up Airbyte to connect to that destination. See the Postgres destination guide for an example of what this should look like. diff --git a/docs/contributing/contributing-to-airbyte/updating-documentation-1.md b/docs/contributing/contributing-to-airbyte/updating-documentation.md similarity index 100% rename from docs/contributing/contributing-to-airbyte/updating-documentation-1.md rename to docs/contributing/contributing-to-airbyte/updating-documentation.md