1
0
mirror of synced 2025-12-25 02:09:19 -05:00

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 <abhivaidyanatha@Abhis-MacBook-Pro.local>
This commit is contained in:
Abhi Vaidyanatha
2021-05-04 17:09:29 -07:00
committed by GitHub
parent fa33c9c126
commit 4710e5836f
16 changed files with 25 additions and 12 deletions

View File

@@ -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=<name>`*
- [ ] 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-<name>`
## Documentation

View File

@@ -0,0 +1 @@
# Python CDK Concepts

View File

@@ -0,0 +1 @@
# Python CDK Tutorials

View File

@@ -0,0 +1 @@
# Creating a HTTP Source with the Airbyte Python CDK

View File

@@ -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)

View File

@@ -1,2 +0,0 @@
# Using the Airbyte CDK

View File

@@ -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)