From a528c21de3ad7c39b150b6f6b306670f0f08a5ad Mon Sep 17 00:00:00 2001 From: Raymond Cheng Date: Sun, 23 Jun 2024 11:21:58 -0700 Subject: [PATCH] docs: refactor integrate section (#1698) * New 3rd party tools doc * New SQL query guide * New data overview guide, with instructions on how to subscribe to a dataset --- apps/docs/docs/get-started/index.mdx | 46 +++++-- apps/docs/docs/integrate/3rd-party.md | 8 -- apps/docs/docs/integrate/3rd-party.mdx | 88 ++++++++++++ apps/docs/docs/integrate/api.md | 10 +- .../docs/integrate/bigquery_cost_estimate.png | Bin 0 -> 77741 bytes apps/docs/docs/integrate/fork-pipeline.md | 2 +- .../integrate/gcp_service_account_create.png | Bin 0 -> 279997 bytes .../integrate/gcp_service_account_key.png | Bin 0 -> 325635 bytes .../integrate/gcp_service_account_perm.png | Bin 0 -> 379699 bytes .../docs/integrate/hex_add_connection.png | Bin 0 -> 326840 bytes apps/docs/docs/integrate/hex_connections.png | Bin 0 -> 56846 bytes apps/docs/docs/integrate/hex_query.png | Bin 0 -> 562932 bytes apps/docs/docs/integrate/index.md | 16 +-- apps/docs/docs/integrate/oss-directory.md | 2 +- .../overview/bigquery_starred_datasets.png | Bin 0 -> 44896 bytes .../integrate/overview/bigquery_subscribe.png | Bin 0 -> 76366 bytes apps/docs/docs/integrate/overview/index.mdx | 127 +++++++++++------- apps/docs/docs/integrate/python-notebooks.md | 13 +- apps/docs/docs/integrate/query-data.md | 10 -- apps/docs/docs/integrate/query-data.mdx | 96 +++++++++++++ 20 files changed, 321 insertions(+), 97 deletions(-) delete mode 100644 apps/docs/docs/integrate/3rd-party.md create mode 100644 apps/docs/docs/integrate/3rd-party.mdx create mode 100644 apps/docs/docs/integrate/bigquery_cost_estimate.png create mode 100644 apps/docs/docs/integrate/gcp_service_account_create.png create mode 100644 apps/docs/docs/integrate/gcp_service_account_key.png create mode 100644 apps/docs/docs/integrate/gcp_service_account_perm.png create mode 100644 apps/docs/docs/integrate/hex_add_connection.png create mode 100644 apps/docs/docs/integrate/hex_connections.png create mode 100644 apps/docs/docs/integrate/hex_query.png create mode 100644 apps/docs/docs/integrate/overview/bigquery_starred_datasets.png create mode 100644 apps/docs/docs/integrate/overview/bigquery_subscribe.png delete mode 100644 apps/docs/docs/integrate/query-data.md create mode 100644 apps/docs/docs/integrate/query-data.mdx diff --git a/apps/docs/docs/get-started/index.mdx b/apps/docs/docs/get-started/index.mdx index e94dd8445..5867e18dd 100644 --- a/apps/docs/docs/get-started/index.mdx +++ b/apps/docs/docs/get-started/index.mdx @@ -4,6 +4,7 @@ sidebar_position: 1 --- import Link from "@docusaurus/Link"; +import Button from "../../src/components/plasmic/Button"; :::info There are two easy ways of accessing OSO datasets: through our GraphQL API @@ -16,8 +17,8 @@ it's best to go direct to the data warehouse. OSO's data warehouse is currently located in BigQuery on Google Cloud (GCP). Every data model is made publicly available by a BigQuery dataset. -See our [data exchange](https://console.cloud.google.com/bigquery/analytics-hub/exchanges/projects/87806073973/locations/us/dataExchanges/open_source_observer_190181416ae) -on Google Analytics Hub for a full list of public data sets. +See our [data overview](../integrate/overview/index.mdx) +for a full list of public data sets. ## Sign up for Google Cloud @@ -25,7 +26,7 @@ Navigate to [Google Cloud](https://cloud.google.com/) and log in. If this is your first time here, you can sign up for a free cloud account using your existing Google account. If you already have a GCP account, -[skip to the query](#make-your-first-query). +[skip to the dataset](#subscribe-to-the-oso-production-dataset). ![GCP Signup](./gcp_signup.png) @@ -44,7 +45,7 @@ Finally, you will be brought to the admin console where you can create a new pro Feel free to name this GCP project anything you'd like. (Or you can simply leave the default project name 'My First Project'.) -## Make your first query +## Subscribe to the OSO production dataset Go to the [BigQuery Console](https://console.cloud.google.com/bigquery). Navigate to **BigQuery** from the left-hand menu and @@ -59,18 +60,36 @@ This will be your workspace for querying the OSO dataset. ![GCP Welcome](./gcp_welcome.png) +Click on the following link to subscribe to the OSO production dataset: + +