Rearrange connector contribution docs (airbytehq#24004)

catpineapple · Mar 14, 2023 · 1feda08 · 1feda08
1 parent 02f771b
commit 1feda08
Show file tree

Hide file tree

Showing 6 changed files with 124 additions and 133 deletions.
diff --git a/docs/connector-development/README.md b/docs/connector-development/README.md
@@ -6,21 +6,21 @@ To build a new connector in Java or Python, we provide templates so you don't ne
 
 **Note: you are not required to maintain the connectors you create.** The goal is that the Airbyte core team and the community help maintain the connector.
 
-## Low-code Connector-Development Framework
+Airbyte provides some Connector Development Kits (CDKs) to help you build connectors.
+
+### Low-code Connector-Development Framework
 
 You can use the [low-code framework](config-based/low-code-cdk-overview.md) to build source connectors for REST APIs via a [connector builder UI](config-based/connector-builder-ui.md) or by modifying boilerplate YAML files.
 
-## Python Connector-Development Kit \(CDK\)
+### Python Connector-Development Kit \(CDK\)
 
 You can build a connector very quickly in Python with the [Airbyte CDK](cdk-python/), which generates 75% of the code required for you.
 
-## C#/.NET Connector-Development Kit \(CDK\)
-
-You can build a connector very quickly in C# .NET with the [Airbyte Dotnet CDK](cdk-dotnet/), which generates 75% of the code required for you.
-
-## TS/JS Connector-Development Kit \(Faros AI Airbyte CDK\)
+### Community maintained CDKs
+The Airbyte community also maintains some CDKs:
 
-You can build a connector in TypeScript/JavaScript with the [Faros AI CDK](https://github.com/airbytehq/airbyte/tree/01b905a38385ca514c2d9c07cc44a8f9a48ce762/docs/connector-development/cdk-faros-js/README.md), which generates and boostraps most of the code required for HTTP Airbyte sources.
+* The [Typescript CDK](https://github.com/faros-ai/airbyte-connectors) is actively maintained by Faros.ai for use in their product.
+* The [Airbyte Dotnet CDK](cdk-dotnet/) comes with C# templates which can be used to generate 75% of the code required for you
 
 ## The Airbyte specification
 

diff --git a/docs/connector-development/airbyte101.md b/docs/connector-development/airbyte101.md
diff --git a/docs/connector-development/cdk-faros-js.md b/docs/connector-development/cdk-faros-js.md
diff --git a/docs/connector-development/cdk-python/README.md b/docs/connector-development/cdk-python/README.md
@@ -1,9 +1,13 @@
-# Connector Development Kit (Python)
+# Connector Development Kit
 
 :::info
 Developer updates will be announced via our #using-the-cdk Slack channel. If you are using the CDK, please join to stay up to date on changes and issues.
 :::
 
+:::info
+This section is for the Python CDK. See our [community-maintained CDKs section](../README.md#community-maintained-cdks) 
+if you want to write connectors in other languages. 
+:::
 The Airbyte Python CDK is a framework for rapidly developing production-grade Airbyte connectors. The CDK currently offers helpers specific for creating Airbyte source connectors for:
 
 * HTTP APIs \(REST APIs, GraphQL, etc..\)

diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js
@@ -222,7 +222,7 @@ module.exports = {
       items: [
         {
           type: 'doc',
-          label: 'CDK Introduction',
+          label: 'Overview',
           id: 'connector-development/README',
         },
         {
@@ -279,29 +279,10 @@ module.exports = {
             'connector-development/config-based/advanced-topics',
           ]
         },
-        'connector-development/tutorials/cdk-speedrun',
-        {
-          type: 'category',
-          label: 'Python CDK: Creating a HTTP API Source',
-          items: [
-            'connector-development/tutorials/cdk-tutorial-python-http/getting-started',
-            'connector-development/tutorials/cdk-tutorial-python-http/creating-the-source',
-            'connector-development/tutorials/cdk-tutorial-python-http/install-dependencies',
-            'connector-development/tutorials/cdk-tutorial-python-http/define-inputs',
-            'connector-development/tutorials/cdk-tutorial-python-http/connection-checking',
-            'connector-development/tutorials/cdk-tutorial-python-http/declare-schema',
-            'connector-development/tutorials/cdk-tutorial-python-http/read-data',
-            'connector-development/tutorials/cdk-tutorial-python-http/use-connector-in-airbyte',
-            'connector-development/tutorials/cdk-tutorial-python-http/test-your-connector',
-          ]
-        },
-        'connector-development/tutorials/building-a-python-source',
-        'connector-development/tutorials/building-a-python-destination',
-        'connector-development/tutorials/building-a-java-destination',
-        'connector-development/tutorials/profile-java-connector-memory',
+
         {
           type: 'category',
-          label: 'Connector Development Kit (Python)',
+          label: 'Connector Development Kit',
           link: {
             type: 'doc',
             id: 'connector-development/cdk-python/README',
@@ -316,8 +297,6 @@ module.exports = {
             'connector-development/cdk-python/stream-slices',
           ]
         },
-        'connector-development/cdk-faros-js',
-        'connector-development/airbyte101',
         {
           type: 'category',
           label: 'Testing Connectors',
@@ -333,6 +312,32 @@ module.exports = {
             'connector-development/testing-connectors/testing-a-local-catalog-in-development',
           ]
         },
+        {
+          type: 'category',
+          label: 'Tutorials',
+          items:[
+            'connector-development/tutorials/cdk-speedrun',
+            {
+                type: 'category',
+                label: 'Python CDK: Creating a HTTP API Source',
+                items: [
+                  'connector-development/tutorials/cdk-tutorial-python-http/getting-started',
+                  'connector-development/tutorials/cdk-tutorial-python-http/creating-the-source',
+                  'connector-development/tutorials/cdk-tutorial-python-http/install-dependencies',
+                  'connector-development/tutorials/cdk-tutorial-python-http/define-inputs',
+                  'connector-development/tutorials/cdk-tutorial-python-http/connection-checking',
+                  'connector-development/tutorials/cdk-tutorial-python-http/declare-schema',
+                  'connector-development/tutorials/cdk-tutorial-python-http/read-data',
+                  'connector-development/tutorials/cdk-tutorial-python-http/use-connector-in-airbyte',
+                  'connector-development/tutorials/cdk-tutorial-python-http/test-your-connector',
+                ]
+            },
+            'connector-development/tutorials/building-a-python-source',
+            'connector-development/tutorials/building-a-python-destination',
+            'connector-development/tutorials/building-a-java-destination',
+            'connector-development/tutorials/profile-java-connector-memory'
+          ]
+        },
         'connector-development/connector-specification-reference',
         'connector-development/best-practices',
         'connector-development/ux-handbook',