From 4710e5836f91029665d3dffae250f9ed5019698c Mon Sep 17 00:00:00 2001 From: Abhi Vaidyanatha Date: Tue, 4 May 2021 17:09:29 -0700 Subject: [PATCH] Adding concepts docs, structure for CDK documentation (#3220) * Adding concepts docs, structure for CDK documentation * Add more context to the CDK README Co-authored-by: Abhi Vaidyanatha --- .../new_python_source.md | 1 + airbyte-cdk/python/docs/concepts/README.md | 1 + airbyte-cdk/python/docs/tutorials/README.md | 1 + .../0-getting-started.md | 0 .../1-creating-the-source.md | 0 .../2-install-dependencies.md | 0 .../3-define-inputs.md | 0 .../4-connection-checking.md | 0 .../5-declare-schema.md | 0 .../cdk-tutorial-python-http}/6-read-data.md | 0 .../7-use-connector-in-airbyte.md | 0 .../8-test-your-connector.md | 0 .../cdk-tutorial-python-http/README.md | 1 + docs/SUMMARY.md | 26 ++++++++++++------- .../cdk-tutorial-alpha/README.md | 2 -- .../using-the-airbyte-cdk/README.md | 5 ++++ 16 files changed, 25 insertions(+), 12 deletions(-) create mode 100644 airbyte-cdk/python/docs/concepts/README.md create mode 100644 airbyte-cdk/python/docs/tutorials/README.md rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/0-getting-started.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/1-creating-the-source.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/2-install-dependencies.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/3-define-inputs.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/4-connection-checking.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/5-declare-schema.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/6-read-data.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/7-use-connector-in-airbyte.md (100%) rename {docs/contributing-to-airbyte/cdk-tutorial-alpha => airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http}/8-test-your-connector.md (100%) create mode 100644 airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/README.md delete mode 100644 docs/contributing-to-airbyte/cdk-tutorial-alpha/README.md create mode 100644 docs/contributing-to-airbyte/using-the-airbyte-cdk/README.md diff --git a/.github/PULL_REQUEST_TEMPLATE/new_python_source.md b/.github/PULL_REQUEST_TEMPLATE/new_python_source.md index 848ac69a799..ef7f3ea32b8 100644 --- a/.github/PULL_REQUEST_TEMPLATE/new_python_source.md +++ b/.github/PULL_REQUEST_TEMPLATE/new_python_source.md @@ -11,6 +11,7 @@ Thanks for contributing to Airbyte! Please complete the following items in order - [ ] Added the credentials for this integration to Github secrets - [ ] Run standard tests on this branch by commenting `/test connector=`* - [ ] Add entry in `airbyte-config/init/src/main/resources/seed/source_definitions.yaml` to use the new source in Airbyte core + - [ ] Generate UUID for `source_definitions` template here: https://www.uuidgenerator.net/ - [ ] Deployed the connector to Dockerhub via `./tools/integrations/manage.sh publish airbyte-integrations/connectors/source-` ## Documentation diff --git a/airbyte-cdk/python/docs/concepts/README.md b/airbyte-cdk/python/docs/concepts/README.md new file mode 100644 index 00000000000..a5cbf3c8bb0 --- /dev/null +++ b/airbyte-cdk/python/docs/concepts/README.md @@ -0,0 +1 @@ +# Python CDK Concepts \ No newline at end of file diff --git a/airbyte-cdk/python/docs/tutorials/README.md b/airbyte-cdk/python/docs/tutorials/README.md new file mode 100644 index 00000000000..88a9eb947ff --- /dev/null +++ b/airbyte-cdk/python/docs/tutorials/README.md @@ -0,0 +1 @@ +# Python CDK Tutorials \ No newline at end of file diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/0-getting-started.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/0-getting-started.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/0-getting-started.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/0-getting-started.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/1-creating-the-source.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/1-creating-the-source.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/1-creating-the-source.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/1-creating-the-source.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/2-install-dependencies.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/2-install-dependencies.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/2-install-dependencies.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/2-install-dependencies.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/3-define-inputs.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/3-define-inputs.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/3-define-inputs.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/3-define-inputs.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/4-connection-checking.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/4-connection-checking.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/4-connection-checking.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/4-connection-checking.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/5-declare-schema.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/5-declare-schema.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/5-declare-schema.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/5-declare-schema.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/6-read-data.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/6-read-data.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/6-read-data.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/6-read-data.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/7-use-connector-in-airbyte.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/7-use-connector-in-airbyte.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/7-use-connector-in-airbyte.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/7-use-connector-in-airbyte.md diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/8-test-your-connector.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/8-test-your-connector.md similarity index 100% rename from docs/contributing-to-airbyte/cdk-tutorial-alpha/8-test-your-connector.md rename to airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/8-test-your-connector.md diff --git a/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/README.md b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/README.md new file mode 100644 index 00000000000..b9e1b791b36 --- /dev/null +++ b/airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/README.md @@ -0,0 +1 @@ +# Creating a HTTP Source with the Airbyte Python CDK \ No newline at end of file diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index bd6f1517dc6..02a9c0914a8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -91,21 +91,27 @@ * [Code of Conduct](contributing-to-airbyte/code-of-conduct.md) * [Developing Locally](contributing-to-airbyte/developing-locally.md) * [Developing Connectors](contributing-to-airbyte/building-new-connector/README.md) + * [Using the Airbyte CDK](contributing-to-airbyte/using-the-airbyte-cdk/README.md) + * [Python](../airbyte-cdk/python/README.md) + * [Concepts](../airbyte-cdk/python/docs/concepts/README.md) + * [Overview](../airbyte-cdk/python/docs/concepts/overview.md) + * [Stream Slices](../airbyte-cdk/python/docs/concepts/stream_slices.md) + * [Tutorials](../airbyte-cdk/python/docs/tutorials/README.md) + * [Python CDK Tutorial](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/README.md) + * [Getting Started](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/0-getting-started.md) + * [Step 1: Creating the Source](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/1-creating-the-source.md) + * [Step 2: Install Dependencies](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/2-install-dependencies.md) + * [Step 3: Define Inputs](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/3-define-inputs.md) + * [Step 4: Connection Checking](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/4-connection-checking.md) + * [Step 5: Declare the Schema](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/5-declare-schema.md) + * [Step 6: Read Data](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/6-read-data.md) + * [Step 7: Use the Connector in Airbyte](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/7-use-connector-in-airbyte.md) + * [Step 8: Test Connector](../airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/8-test-your-connector.md) * [Best Practices](contributing-to-airbyte/building-new-connector/best-practices.md) * [Java Connectors](contributing-to-airbyte/building-new-connector/java-connectors.md) * [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/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) diff --git a/docs/contributing-to-airbyte/cdk-tutorial-alpha/README.md b/docs/contributing-to-airbyte/cdk-tutorial-alpha/README.md deleted file mode 100644 index db948142dd8..00000000000 --- a/docs/contributing-to-airbyte/cdk-tutorial-alpha/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Using the Airbyte CDK - diff --git a/docs/contributing-to-airbyte/using-the-airbyte-cdk/README.md b/docs/contributing-to-airbyte/using-the-airbyte-cdk/README.md new file mode 100644 index 00000000000..42dc05e7795 --- /dev/null +++ b/docs/contributing-to-airbyte/using-the-airbyte-cdk/README.md @@ -0,0 +1,5 @@ +# Using the Airbyte CDK + +Airbyte Connector Development Kits (CDK) significantly accelerate connector development. We currently provide a Python CDK, and a Java one is in development. + +Navigate here for more information on the [Python CDK](https://docs.airbyte.io/contributing-to-airbyte/building-new-connector/using-the-airbyte-cdk/python) \ No newline at end of file