Restructured the left column of the documentation (#733)

airbytehq · Oct 29, 2020 · 9a1452e · 9a1452e
1 parent 2f238d6
commit 9a1452e
Show file tree

Hide file tree

Showing 26 changed files with 58 additions and 66 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -3,56 +3,39 @@
 * [Overview](../README.md)
 * [Getting Started](getting-started-tutorial.md)
 * [Changelog](changelog.md)
-
-## Deployment
-
-* [Deploying Airbyte](deployment/deploying-airbyte/README.md)
-  * [On your workstation](deployment/deploying-airbyte/on-your-workstation.md)
-  * [On AWS \(EC2\)](deployment/deploying-airbyte/on-aws-ec2.md)
-  * [On GCP \(Compute Engine\)](deployment/deploying-airbyte/on-gcp-compute-engine.md)
-
-## Integrations
-
-* [Sources](integrations/sources/README.md)
-  * [exchangeratesapi.io](integrations/sources/exchangeratesapi-io.md)
-  * [Github](integrations/sources/github.md)
-  * [Postgres](integrations/sources/postgres.md)
-  * [Salesforce](integrations/sources/salesforce.md)
-  * [Stripe](integrations/sources/stripe.md)
-* [Destinations](integrations/destinations/README.md)
-  * [Local CSV](integrations/destinations/local-csv.md)
-  * [BigQuery](integrations/destinations/bigquery.md)
-  * [Postgres](integrations/destinations/postgres.md)
-* [Custom Connectors](integrations/adding-your-own-connectors.md)
-
-## Contributing
-
-* [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.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)
-
-## Architecture
-
-* [High Level Overview](architecture/high-level-overview.md)
-* [The Airbyte Specification](architecture/airbyte-specification.md)
-* [Technical Stack](architecture/tech-stack.md)
-* [Full Refresh](architecture/full-refresh.md)
-
-## Handbook <a id="company-handbook"></a>
-
-* [Company Handbook](company-handbook/company-handbook/README.md)
-  * [Story](company-handbook/company-handbook/future-milestones.md)
-  * [Culture and Values](company-handbook/company-handbook/culture-and-values.md)
-  * [Team](company-handbook/company-handbook/team.md)
-  * [Strategy](company-handbook/company-handbook/strategy.md)
-  * [Business Model](company-handbook/company-handbook/business-model.md)
-  * [Roadmap](company-handbook/company-handbook/roadmap.md)
-
----
-
+* [Deploying Airbyte](deploying-airbyte/README.md)
+  * [On your workstation](deploying-airbyte/on-your-workstation.md)
+  * [On AWS \(EC2\)](deploying-airbyte/on-aws-ec2.md)
+  * [On GCP \(Compute Engine\)](deploying-airbyte/on-gcp-compute-engine.md)
+* [Architecture](high-level-overview/README.md)
+  * [The Airbyte Specification](high-level-overview/airbyte-specification.md)
+  * [Technical Stack](high-level-overview/tech-stack.md)
+  * [Full Refresh](high-level-overview/full-refresh.md)
+* [Integrations](integrations/README.md)
+  * [Sources](integrations/sources/README.md)
+    * [exchangeratesapi.io](integrations/sources/exchangeratesapi-io.md)
+    * [Github](integrations/sources/github.md)
+    * [Postgres](integrations/sources/postgres.md)
+    * [Salesforce](integrations/sources/salesforce.md)
+    * [Stripe](integrations/sources/stripe.md)
+  * [Destinations](integrations/destinations/README.md)
+    * [Local CSV](integrations/destinations/local-csv.md)
+    * [BigQuery](integrations/destinations/bigquery.md)
+    * [Postgres](integrations/destinations/postgres.md)
+  * [Custom Connectors](integrations/adding-your-own-connectors.md)
+* [Contributing to Airbyte](contributing-to-airbyte/README.md)
+  * [Code of Conduct](contributing-to-airbyte/code-of-conduct.md)
+  * [Developing Locally](contributing-to-airbyte/developing-locally.md)
+  * [Code Style](contributing-to-airbyte/code-style.md)
+  * [Updating Documentation](contributing-to-airbyte/updating-documentation.md)
+  * [Documentation Templates](contributing-to-airbyte/documentation-templates/README.md)
+    * [Integration Doc Template](contributing-to-airbyte/documentation-templates/integration-documentation-template.md)
+* [Company Handbook](company-handbook/README.md)
+  * [Story](company-handbook/future-milestones.md)
+  * [Culture and Values](company-handbook/culture-and-values.md)
+  * [Team](company-handbook/team.md)
+  * [Strategy](company-handbook/strategy.md)
+  * [Business Model](company-handbook/business-model.md)
+  * [Roadmap](company-handbook/roadmap.md)
 * [License](license.md)
 
diff --git a/...mpany-handbook/company-handbook/README.md → docs/company-handbook/README.md b/...mpany-handbook/company-handbook/README.md → docs/company-handbook/README.md
diff --git a/...ndbook/company-handbook/business-model.md → docs/company-handbook/business-model.md b/...ndbook/company-handbook/business-model.md → docs/company-handbook/business-model.md
diff --git a/...ok/company-handbook/culture-and-values.md → docs/company-handbook/culture-and-values.md b/...ok/company-handbook/culture-and-values.md → docs/company-handbook/culture-and-values.md
diff --git a/...ook/company-handbook/future-milestones.md → docs/company-handbook/future-milestones.md b/...ook/company-handbook/future-milestones.md → docs/company-handbook/future-milestones.md
diff --git a/...pany-handbook/company-handbook/roadmap.md → docs/company-handbook/roadmap.md b/...pany-handbook/company-handbook/roadmap.md → docs/company-handbook/roadmap.md
diff --git a/...any-handbook/company-handbook/strategy.md → docs/company-handbook/strategy.md b/...any-handbook/company-handbook/strategy.md → docs/company-handbook/strategy.md
diff --git a/...company-handbook/company-handbook/team.md → docs/company-handbook/team.md b/...company-handbook/company-handbook/team.md → docs/company-handbook/team.md
diff --git a/...ibuting/contributing-to-airbyte/README.md → docs/contributing-to-airbyte/README.md b/...ibuting/contributing-to-airbyte/README.md → docs/contributing-to-airbyte/README.md
diff --git a/docs/contributing/code-of-conduct.md → ...ontributing-to-airbyte/code-of-conduct.md b/docs/contributing/code-of-conduct.md → ...ontributing-to-airbyte/code-of-conduct.md
diff --git a/...ing/contributing-to-airbyte/code-style.md → docs/contributing-to-airbyte/code-style.md b/...ing/contributing-to-airbyte/code-style.md → docs/contributing-to-airbyte/code-style.md
diff --git a/...ributing-to-airbyte/developing-locally.md → ...ributing-to-airbyte/developing-locally.md b/...ributing-to-airbyte/developing-locally.md → ...ributing-to-airbyte/developing-locally.md
diff --git a/...airbyte/documentation-templates/README.md → ...airbyte/documentation-templates/README.md b/...airbyte/documentation-templates/README.md → ...airbyte/documentation-templates/README.md
diff --git a/...tes/integration-documentation-template.md → ...tes/integration-documentation-template.md b/...tes/integration-documentation-template.md → ...tes/integration-documentation-template.md
diff --git a/...ting-to-airbyte/updating-documentation.md → ...ting-to-airbyte/updating-documentation.md b/...ting-to-airbyte/updating-documentation.md → ...ting-to-airbyte/updating-documentation.md
diff --git a/docs/deployment/deploying-airbyte/README.md → docs/deploying-airbyte/README.md b/docs/deployment/deploying-airbyte/README.md → docs/deploying-airbyte/README.md
diff --git a/...eployment/deploying-airbyte/on-aws-ec2.md → docs/deploying-airbyte/on-aws-ec2.md b/...eployment/deploying-airbyte/on-aws-ec2.md → docs/deploying-airbyte/on-aws-ec2.md
@@ -8,15 +8,15 @@ The instructions have been tested on `Amazon Linux 2 AMI (HVM)`
 
 * Launch a new instance
 
-![](../../.gitbook/assets/aws_ec2_launch%20%281%29.png)
+![](../.gitbook/assets/aws_ec2_launch%20%281%29.png)
 
 * Select instance AMI
 
-![](../../.gitbook/assets/aws_ec2_ami%20%281%29.png)
+![](../.gitbook/assets/aws_ec2_ami%20%281%29.png)
 
 * Select instance type
 
-![](../../.gitbook/assets/aws_ec2_instance_type%20%281%29.png)
+![](../.gitbook/assets/aws_ec2_instance_type%20%281%29.png)
 
 * `Next: Configure Instance Details` 
   * You can tune parameters or keep the defaults
@@ -27,18 +27,18 @@ The instructions have been tested on `Amazon Linux 2 AMI (HVM)`
 * `Next: Configure Security Groups`
   * We are going to allow network for `ssh` 
 
-![](../../.gitbook/assets/aws_ec2_security_group%20%281%29.png)
+![](../.gitbook/assets/aws_ec2_security_group%20%281%29.png)
 
 * `Review and Launch`
 * `Launch`
 * Create a ssh key so you can connect to the instance
   * Download the key \(and don't lose it or you won't be able to connect to the instance\)
 
-![](../../.gitbook/assets/aws_ec2_ssh_key%20%281%29.png)
+![](../.gitbook/assets/aws_ec2_ssh_key%20%281%29.png)
 
 * `Launch Instances`
 
-![](../../.gitbook/assets/aws_ec2_instance_view%20%281%29.png)
+![](../.gitbook/assets/aws_ec2_instance_view%20%281%29.png)
 
 * Wait for the instance to become `Running`
 

diff --git a/...eploying-airbyte/on-gcp-compute-engine.md → ...eploying-airbyte/on-gcp-compute-engine.md b/...eploying-airbyte/on-gcp-compute-engine.md → ...eploying-airbyte/on-gcp-compute-engine.md
@@ -8,11 +8,11 @@ The instructions have been tested on `Debian GNU/Linux 10 (buster)`
 
 * Launch a new instance
 
-![](../../.gitbook/assets/gcp_ce_launch%20%281%29.png)
+![](../.gitbook/assets/gcp_ce_launch%20%281%29.png)
 
 * Configure new instance
 
-![](../../.gitbook/assets/gcp_ce_configure%20%281%29.png)
+![](../.gitbook/assets/gcp_ce_configure%20%281%29.png)
 
 * `Create`
 

diff --git a/.../deploying-airbyte/on-your-workstation.md → .../deploying-airbyte/on-your-workstation.md b/.../deploying-airbyte/on-your-workstation.md → .../deploying-airbyte/on-your-workstation.md
diff --git a/docs/architecture/high-level-overview.md → docs/high-level-overview/README.md b/docs/architecture/high-level-overview.md → docs/high-level-overview/README.md
@@ -1,6 +1,8 @@
-# High Level Overview
+---
+description: Here is a high level view of Airbyte's components.
+---
 
-Here is a high level view of Airbyte's components:
+# Architecture
 
 ![3.048-Kilometer view](../.gitbook/assets/10-000-feet-view%20%281%29.png)
 

diff --git a/docs/architecture/airbyte-specification.md → ...h-level-overview/airbyte-specification.md b/docs/architecture/airbyte-specification.md → ...h-level-overview/airbyte-specification.md
@@ -15,7 +15,7 @@
 2. [Integration primitives](airbyte-specification.md#primitives)
 3. [Details of the protocol to pass information between integrations](airbyte-specification.md#the-airbyte-protocol)
 
-This document is focused on the interfaces and primitives around integrations. You can better understand how that fits into the bigger picture by checking out the [Airbyte Architecture](high-level-overview.md).
+This document is focused on the interfaces and primitives around integrations. You can better understand how that fits into the bigger picture by checking out the [Airbyte Architecture](./).
 
 ## General
 

diff --git a/docs/architecture/full-refresh.md → docs/high-level-overview/full-refresh.md b/docs/architecture/full-refresh.md → docs/high-level-overview/full-refresh.md
diff --git a/docs/architecture/tech-stack.md → docs/high-level-overview/tech-stack.md b/docs/architecture/tech-stack.md → docs/high-level-overview/tech-stack.md
diff --git a/docs/integrations/README.md b/docs/integrations/README.md
@@ -0,0 +1,2 @@
+# Integrations
+
diff --git a/docs/integrations/sources/github.md b/docs/integrations/sources/github.md
@@ -8,7 +8,7 @@ This Github source wraps the [Singer Github Tap](https://github.com/singer-io/ta
 
 ### Output schema
 
-Several output streams are available from this source \(commits, issues, pull_requests, etc.\) For a comprehensive output schema [look at the Singer tap schema files](https://github.com/singer-io/tap-github/tree/master/tap_github/schemas).
+Several output streams are available from this source \(commits, issues, pull\_requests, etc.\) For a comprehensive output schema [look at the Singer tap schema files](https://github.com/singer-io/tap-github/tree/master/tap_github/schemas).
 
 ### Features
 
@@ -35,3 +35,4 @@ The Github connector should not run into Github API limitations under normal usa
 Log into Github and then generate a [personal access token](https://github.com/settings/tokens).
 
 We recommend creating a restricted key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access.
+
diff --git a/docs/integrations/sources/salesforce.md b/docs/integrations/sources/salesforce.md
@@ -8,7 +8,7 @@ This source wraps the Singer.io [tap-salesforce](https://github.com/singer-io/ta
 
 ### Output schema
 
-Several output streams are available from this source. A list of these streams can be found below in the [Streams](#streams) section.
+Several output streams are available from this source. A list of these streams can be found below in the [Streams](salesforce.md#streams) section.
 
 ### Features
 
@@ -34,11 +34,14 @@ The connector is restricted by normal Salesforce rate limiting. For large transf
 
 We recommend the following [walkthrough](https://medium.com/@bpmmendis94/obtain-access-refresh-tokens-from-salesforce-rest-api-a324fe4ccd9b) for setting up a Salesforce app that can pull data from Salesforce and locating the credentials you need to provide to Airbyte.
 
-#### is_sandbox
-If you log in using at https://login.salesforce.com, then the value is false. If you log in at https://test.salesforce.com then the value should be true. If this is Greek to you, then this value should probably be false.
+#### is\_sandbox
+
+If you log in using at [https://login.salesforce.com](https://login.salesforce.com), then the value is false. If you log in at [https://test.salesforce.com](https://test.salesforce.com) then the value should be true. If this is Greek to you, then this value should probably be false.
 
 ## Streams
+
 List of available streams.
+
 * ServiceAppointmentFeed
 * ThirdPartyAccountLink
 * DataAssessmentFieldMetric
@@ -404,3 +407,4 @@ List of available streams.
 * Stamp
 * OperatingHoursFeed
 * ExternalDataSource
+