From cddf861c31c19edea06a178c68d4f47027b99784 Mon Sep 17 00:00:00 2001 From: Igor Lukanin Date: Wed, 10 Jan 2024 16:00:53 +0100 Subject: [PATCH 1/2] Workspace tools page, creating a (demo) new deployment, updates to the getting started page --- .../configuration/data-sources/duckdb.mdx | 25 +++++--- docs/pages/product/data-modeling/overview.mdx | 8 +++ .../product/deployment/cloud/deployments.mdx | 48 ++++++++++++++- docs/pages/product/getting-started.mdx | 61 ++++++++++++++++--- docs/pages/product/getting-started/_meta.js | 2 +- docs/pages/product/workspace.mdx | 56 +++++++++++++++++ 6 files changed, 180 insertions(+), 20 deletions(-) create mode 100644 docs/pages/product/workspace.mdx diff --git a/docs/pages/product/configuration/data-sources/duckdb.mdx b/docs/pages/product/configuration/data-sources/duckdb.mdx index e5209af6b1f1a..b0e05acba0254 100644 --- a/docs/pages/product/configuration/data-sources/duckdb.mdx +++ b/docs/pages/product/configuration/data-sources/duckdb.mdx @@ -3,7 +3,7 @@ [DuckDB][duckdb] is an in-process SQL OLAP database management system, and has support for querying data in CSV, JSON and Parquet formats from an AWS S3-compatible blob storage. This means you can [query data stored in AWS S3, -Google Cloud Storage, or CloudFlare R2][duckdb-docs-s3-import]. +Google Cloud Storage, or Cloudflare R2][duckdb-docs-s3-import]. @@ -33,19 +33,27 @@ CUBEJS_DB_TYPE=duckdb ### Cube Cloud -In Cube Cloud, select **DuckDB** when creating a new deployment and fill in the -required fields: +In Cube Cloud, select DuckDB when creating a new deployment +and fill in the required fields: + + -If you are not using MotherDuck, leave the **MotherDuck Token** field blank. +If you are not using MotherDuck, leave the MotherDuck Token +field blank. - + + +You can also explore how DuckDB works with Cube if you create a [demo +deployment][ref-demo-deployment] in Cube Cloud. + + ## Environment Variables @@ -124,3 +132,4 @@ connections are made over HTTPS. [ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-model/types-and-formats#count-distinct-approx [self-preaggs-batching]: #batching +[ref-demo-deployment]: /product/deployment/cloud/deployments#demo-deployments \ No newline at end of file diff --git a/docs/pages/product/data-modeling/overview.mdx b/docs/pages/product/data-modeling/overview.mdx index e1310cdec2e60..1630b041228bc 100644 --- a/docs/pages/product/data-modeling/overview.mdx +++ b/docs/pages/product/data-modeling/overview.mdx @@ -11,6 +11,13 @@ exposed through the [querying API][ref-backend-restapi] that allows end-users to query a wide variety of analytical queries without modifying the data model itself. + + +You can explore a carefully crafted sample data model if you create a [demo +deployment][ref-demo-deployment] in Cube Cloud. + + + Let’s use a users table with the following columns as an example: | id | paying | city | company_name | @@ -302,3 +309,4 @@ As with other measures, `paying_percentage` can be used with dimensions. [ref-schema-types-formats]: /reference/data-model/types-and-formats [ref-examples]: /guides/examples [ref-backend-query-format]: /product/apis-integrations/rest-api/query-format +[ref-demo-deployment]: /product/deployment/cloud/deployments#demo-deployments diff --git a/docs/pages/product/deployment/cloud/deployments.mdx b/docs/pages/product/deployment/cloud/deployments.mdx index 7f97647c3d23e..87c1dcd55de7f 100644 --- a/docs/pages/product/deployment/cloud/deployments.mdx +++ b/docs/pages/product/deployment/cloud/deployments.mdx @@ -12,6 +12,44 @@ the Cube Cloud logo in the top left corner. +## Creating a new deployment + +Creating a new deployment is an essential prerequisite to running a Cube +project in Cube Cloud. + +After you've created your [Cube Cloud account][cube-cloud-signup], +click + Create Deployment in the top-right corner of your +list of deployments to jump into the wizard. Watch the following video for +guidance on the rest of the steps: + + + +## Demo deployments + +After you've created your [Cube Cloud account][cube-cloud-signup] and +proceeded to create a new deployment, you would be prompted to set up a +connection to your [data source][ref-data-source]. + +If, for any reason, you're not ready or unable to connect your staging or +production data source at the moment, you can click Create a demo +deployment in the yellow box: + + + +Shortly, Cube Cloud will create and pre-configure a new deployment in your +account. You will see it as Demo deployment in the list of +deployments. This new deployment will be: + +- Configured to use [DuckDB][ref-duckdb] as the data source. +- Provided with a sample [data model][ref-data-model] backed with CSV files +in a public S3 bucket. +- Provided with an example of [dynamic data modeling][ref-dynamic-data-models] +and programmatic [configuration options][ref-config-options]. + +Exploring the demo deployment is a great way to understand how Cube works. +Use the [data model editor][ref-data-model] to review the data model and +make sure to run a few queries in [Playground][ref-playground]. + ## Deployment overview The Overview page of each deployment provides a high-level @@ -59,8 +97,16 @@ Please refer to [total cost examples][ref-total-cost] to learn more about resource consumption in different scenarios. +[cube-cloud-signup]: https://cubecloud.dev/auth/signup [ref-deployment-types]: /product/deployment/cloud/deployment-types [ref-dev-instance]: /product/deployment/cloud/deployment-types#development-instance [ref-dev-mode]: /product/workspace/dev-mode [ref-auto-sus]: /product/deployment/cloud/auto-suspension -[ref-total-cost]: /product/deployment/cloud/pricing#total-cost-examples \ No newline at end of file +[ref-total-cost]: /product/deployment/cloud/pricing#total-cost-examples +[ref-data-source]: /product/configuration/data-sources +[ref-duckdb]: /product/configuration/data-sources/duckdb +[ref-data-model]: /product/data-modeling/overview +[ref-dynamic-data-models]: /product/data-modeling/dynamic +[ref-config-options]: /product/configuration#configuration-options +[ref-data-model]: /product/workspace/data-model +[ref-playground]: /product/workspace/playground \ No newline at end of file diff --git a/docs/pages/product/getting-started.mdx b/docs/pages/product/getting-started.mdx index 23b9c2e5959d8..7fc83482b8141 100644 --- a/docs/pages/product/getting-started.mdx +++ b/docs/pages/product/getting-started.mdx @@ -5,25 +5,62 @@ redirect_from: # Getting started with Cube -Cube is a cloud-native application, packaged and distributed as Docker images -and designed to run in a containerized environment. +Cube is a cloud-native application, designed to run in a cloud. You can get +started with Cube in one of two ways: +- Run Cube in Cube Cloud and use its managed infrastructure and workspace tools. +- Deploy Cube to your own infrastructure with Docker. -You can get started with Cube in one of two ways. +## Getting started with Cube Cloud -We recommend using [Cube Cloud][cube-cloud], our managed platform for Cube, -because it's the easiest way to build, test, deploy, and manage Cube projects. -Cube Cloud includes features such as collaboration for teams, a web-based data -model editor, auto-scaling, and observability. Cube Cloud also comes with a free -tier for development and proof-of-concept projects. +**We recommend using [Cube Cloud][cube-cloud], our managed platform for Cube.** +It's the easiest way to build, test, deploy, and manage Cube projects and +it comes with a free tier for development and proof-of-concept projects. -Alternatively, you can run Cube on your own infrastructure with Docker. +Cube Cloud provides [managed infrastructure][ref-infrastructure] and +[workspace tools][ref-workspace], including features such as collaboration +for teams, a web-based data model editor, synchronization with BI tools, +auto-scaling, and observability. + +Please get started with the following guides, tailored for Snowflake and +Databricks users. You may find them insightful even if you +have one of many other supported [data sources][ref-data-sources]. + + + +Alternatively, you can explore Cube Cloud on your own or learn by example +in a demo deployment: + + + + + + +## Getting started with Cube Core + +Cube Core is packaged and distributed as Docker images that can be run in +a containerized environment. You can run Cube Cube on your own +infrastructure with Docker. + + + +Most workspace tools depend on the [managed infrastructure][ref-infrastructure] +and are only available in Cube Cloud. + + + +## Workspace tools in Cube Cloud + +In Cube Cloud, you can: +* Use the [data model editor][ref-data-model] with the [development +mode][ref-dev-mode] to build the data model of your semantic layer. +* Use [SQL Runner][ref-sql-runner] to inform the development of the data +model. +* Use [Playground][ref-playground] to run queries and test the data model. +* Use [Semantic Layer Sync][ref-sls] to connect your semantic layer to BI +tools. +* Use [Query Hsitory][ref-query-history] to observe queries and their +performance in real-time. +* Use the [pre-aggregations page][ref-pre-aggs] to inspect pre-aggregations +and their build history. +* Use [Performance Insights][ref-perf-insights] to analyze the performance +of your deployment as a whole. +* Use the [access control page][ref-access-control] to manage users of your +Cube Cloud account and [single sign-on][ref-sso]. +* Use [Budgets][ref-budgets] to control the usage and spend of your Cube +Cloud account. +* Use [Preferences][ref-prefs] to adjust the workspace to your liking. + +## Workspace tools in Cube Core + +With Cube Core, you can: + +* Use the data model builder to generate the initial data model. +* Use [Playground][ref-playground] to run queries and test the data model. +* Use the [command-line tool][ref-cli] to automate your workflows. + +[ref-infrastructure]: /product/deployment/cloud +[ref-data-model]: /product/workspace/data-model +[ref-dev-mode]: /product/workspace/dev-mode +[ref-sql-runner]: /product/workspace/sql-runner +[ref-playground]: /product/workspace/playground +[ref-sls]: /product/workspace/semantic-layer-sync +[ref-query-history]: /product/workspace/query-history +[ref-pre-aggs]: /product/workspace/pre-aggregations +[ref-perf-insights]: /product/workspace/performance +[ref-access-control]: /product/workspace/access-control +[ref-sso]: /product/workspace/sso +[ref-budgets]: /product/workspace/budgets +[ref-prefs]: /product/workspace/preferences +[ref-cli]: /product/workspace/cli \ No newline at end of file From 2ababf810df32dc12ac987945eb85902c9a318e5 Mon Sep 17 00:00:00 2001 From: Igor Lukanin Date: Wed, 10 Jan 2024 17:51:00 +0100 Subject: [PATCH 2/2] Add video --- docs/pages/product/deployment/cloud/deployments.mdx | 4 ++++ docs/pages/product/getting-started.mdx | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/pages/product/deployment/cloud/deployments.mdx b/docs/pages/product/deployment/cloud/deployments.mdx index 87c1dcd55de7f..34aabaf6b6820 100644 --- a/docs/pages/product/deployment/cloud/deployments.mdx +++ b/docs/pages/product/deployment/cloud/deployments.mdx @@ -46,6 +46,10 @@ in a public S3 bucket. - Provided with an example of [dynamic data modeling][ref-dynamic-data-models] and programmatic [configuration options][ref-config-options]. +Watch the following video to for a step-by-step walkthrough: + + + Exploring the demo deployment is a great way to understand how Cube works. Use the [data model editor][ref-data-model] to review the data model and make sure to run a few queries in [Playground][ref-playground]. diff --git a/docs/pages/product/getting-started.mdx b/docs/pages/product/getting-started.mdx index 7fc83482b8141..1f3544b1af975 100644 --- a/docs/pages/product/getting-started.mdx +++ b/docs/pages/product/getting-started.mdx @@ -43,12 +43,12 @@ in a demo deployment: