feat: add docs for SQL editor. (timescale#3354)

* feat: add docs for SQL editor.

Co-authored-by: Rahil Sondhi <[email protected]>

Author: billy-the-fish

.data/redirects.js

@@ -389,6 +389,10 @@ const redirector = new ThreeOhOneRedirector({
 		]
 	]
 })
+	.add(
+		"/use-timescale/latest/popsql",
+		"https://docs.timescale.com/getting-started/latest/run-queries-from-console/"
+	)
 	.add(
 		"/ai/latest/pgvectorize",
 		"https://docs.timescale.com/ai/latest/pgvectorizer"
@@ -606,7 +610,7 @@ const redirector = new ThreeOhOneRedirector({
 	)
 	.add(
 		"/cloud/latest/create-a-service",
-		"https://https://docs.timescale.com/getting-started/latest/services/"
+		"https://docs.timescale.com/getting-started/latest/services/"
 	)
 	.add(
 		"/cloud/latest/customize-configuration",
@@ -675,7 +679,7 @@ const redirector = new ThreeOhOneRedirector({
 	)
 	.add(
 		"/use-timescale/latest/services/create-a-service",
-		"https://https://docs.timescale.com/getting-started/latest/services/"
+		"https://docs.timescale.com/getting-started/latest/services/"
 	)
 	.add(
 		"/cloud/latest/service-explorer",
@@ -767,7 +771,7 @@ const redirector = new ThreeOhOneRedirector({
 	.add("/faq", "https://docs.timescale.com/timescaledb/latest/overview/faq/")
 	.add(
 		"/forge/getting-started-forge/",
-		"https://https://docs.timescale.com/getting-started/latest/services/"
+		"https://docs.timescale.com/getting-started/latest/services/"
 	)
 	.add("/forge", "https://docs.timescale.com/cloud/latest/")
 	.add("/getting-started", "https://docs.timescale.com/getting-started/latest/")
@@ -789,7 +793,7 @@ const redirector = new ThreeOhOneRedirector({
 	)
 	.add(
 		"/getting-started/exploring-forge",
-		"https://https://docs.timescale.com/getting-started/latest/services/"
+		"https://docs.timescale.com/getting-started/latest/services/"
 	)
 	.add(
 		"/getting-started/exploring-forge/forge-configuration",
@@ -1027,7 +1031,7 @@ const redirector = new ThreeOhOneRedirector({
 	)
 	.add(
 		"/latest/getting-started/exploring-forge",
-		"https://https://docs.timescale.com/getting-started/latest/services/"
+		"https://docs.timescale.com/getting-started/latest/services/"
 	)
 	.add(
 		"/latest/getting-started/exploring-forge/forge-multi-node",

_partials/_cloud-connect.md

@@ -1,23 +1,35 @@
-<Procedure>
+## Check your service and connect to it
 
-### Check your service and connect to it
+<Procedure>
 
 To ensure a Timescale service is running correctly:
 
-1.  In the [Services section in Timescale Console][services-portal], check that your service is marked as `Running`.
+1. **Check your service**
+
+    In [Timescale Console][services-portal], select a service and check that it is marked as `Running`.
+
+   ![Check service is running](https://assets.timescale.com/docs/images/cloud-sql-editors.png)
+
+1. **Connect to your service**
 
-1. Use PopSQL or psql to connect to your service:
-    - [Setup PopSQL][popsql]: Follow the instructions to easily connect to your service in the UI.
-    - [psql][install-psql]: Connect to your service with the value of `Service URL` from the config file you 
-      just saved.
+    Use either: 
+    - A Cloud SQL editor from Timescale Console:
+      - [SQL editor][run-sqleditor]: in Timescale Console, click `SQL editor`. You can now run queries for this service. 
+      - [PopSQL][popsql]:  in Timescale Console, click `PopSQL`, then follow the instructions to easily connect to 
+        this service with PopSQL.
+    - The command line:
+      - [psql][install-psql]: connect to your service with the value of `Service URL` from the config file you 
+        just saved:
 
-      <CodeBlock canCopy={true} showLineNumbers={false} children={`
-      psql "postgres://tsdbadmin:<PASSWORD>@<HOST>:<PORT>/tsdb?sslmode=require"
-      `} />
+        <CodeBlock canCopy={true} showLineNumbers={false} children={`
+        psql "postgres://tsdbadmin:<PASSWORD>@<HOST>:<PORT>/tsdb?sslmode=require"
+        `} />
 
-    You are connected to your service and are now able to issue commands. 
+    You are connected to your service and can issue commands. 
 
-1.  Create a PostgreSQL table, copy the following into [PopSQL][popsql] or psql, then run your query:
+1. **Create a PostgreSQL table** 
+
+    Copy the following into your SQL editor, then run your query:
 
     ```sql
     CREATE TABLE stocks_real_time (
@@ -28,9 +40,16 @@ To ensure a Timescale service is running correctly:
     );
     ```
 
-1.  Check that the table exists.
-    - In PopSQL, you see the table in the UI. 
-    - In psql, run the `\dt` command, You see the table listing in your service. To disconnect, type `exit`.
+1.  **Check that the table exists**
+
+    - **SQL editor**: run the following query:
+      ```sql
+      SELECT * FROM information_schema.tables where table_name = 'stocks_real_time';
+      ```
+      You see the table listed in the UI.
+
+    - **PopSQL**: the table is automatically displayed when you run the `CREATE` query.  
+    - **psql**: run the `\dt` command. You see the table listing for your service. To disconnect, type `exit`.
 
 
 Quick recap, you find configuration information about your
@@ -43,4 +62,6 @@ config file.
 [account-portal]: https://console.cloud.timescale.com/dashboard/account
 [services-portal]: https://console.cloud.timescale.com/dashboard/services
 [install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
-[popsql]: /use-timescale/:currentVersion:/popsql/
+[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#popsql
+[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
+[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/

_partials/_cloud-installation.md

@@ -1,6 +1,6 @@
-<Procedure>
+## Create a Timescale account
 
-### Create a Timescale account
+<Procedure>
 
 To set up Timescale:
 

_partials/_cloud-intro.md

@@ -1,9 +1,17 @@
-Timescale is a cloud-based PostgreSQL platform for resource-intensive workloads. We help you build faster, scale further, and stay under budget. Timescale offers the following PostgreSQL database optimizations:
+Timescale Cloud is a cloud-based PostgreSQL platform for resource-intensive workloads. We help you build faster, 
+scale further, and stay under budget. Timescale Cloud offers the following PostgreSQL optimized database services:
 
-- [**Time-series data**](https://www.timescale.com/blog/what-is-a-time-series-database/#what-is-a-time-series-database): a
-  TimescaleDB instance optimized for your time-series and analytics workloads. Get automated dynamic data partitioning, hybrid row-columnar storage, advanced compression techniques, incremental up-to-date materializations, and specialized analysis functions as well as cloud-only features like transparent tiering and low-cost object storage.
-
-- **All other workloads**: a [Dynamic PostgreSQL](https://www.timescale.com/dynamic-postgresql) instance where you select a compute range, only paying for the base and the amount of extra CPU as you scale.
+- **[Time-series and Analytics][create-service]**: a Timescale DB instance optimized for your
+  [time-series and analytics][what-is-time-series] workloads. Get automated dynamic data partitioning, hybrid 
+  row-columnar storage, advanced compression techniques, incremental up-to-date materializations, and specialized 
+  analysis functions as well as cloud-only features like transparent tiering and low-cost object storage.
+- **[Dynamic PostgreSQL][create-service]**: for all other workloads. A PostgreSQL instance with a
+  [dynamic compute range][what-is-dynamic-postgres] aligned to your business needs. You select a compute range, only 
+  paying for the base and the amount of extra CPU as you scale.
 
 All databases are extended with lightning fast vector search, and include all the cloud tooling you'd expect for production use,
 with automatic backups, high availability, read replicas, data forking, connection pooling, usage-based storage, and much more.
+
+[what-is-time-series]: https://www.timescale.com/blog/what-is-a-time-series-database/#what-is-a-time-series-database
+[what-is-dynamic-postgres]: https://www.timescale.com/dynamic-postgresql
+[create-service]: /getting-started/:currentVersion:/services/

getting-started/index.md

@@ -6,9 +6,6 @@ layout_components: [next_prev_large]
 content_group: Getting started
 ---
 
-import Install from "versionContent/_partials/_cloud-installation.mdx";
-import CreateService from "versionContent/_partials/_cloud-create-service.mdx";
-import Connect from "versionContent/_partials/_cloud-connect.mdx";
 import CloudIntro from "versionContent/_partials/_cloud-intro.mdx";
 import TimescaleIntro from "versionContent/_partials/_timescale-intro.mdx";
 import WhereNext from "versionContent/_partials/_where-to-next.mdx";
@@ -22,6 +19,7 @@ Each database instance in Timescale is called a service.
 This section shows you how to:
 
 1.  [Create and connect to a Timescale service][services-create]
+1.  [Run queries from Timescale Console][run-queries-from-console]
 1.  [Ingest some real financial data into your database][ingest-data]
 1.  [Construct some interesting queries][queries] <FeaturedCTA href="/getting-started/latest/queries/#try-it-out-code-block-1" data-tracking="cta-try-out-queries">Try out some <b>live queries</b></FeaturedCTA>
 1.  [Create and query a continuous aggregates][caggs]
@@ -34,6 +32,7 @@ Already know the basics? See the
 [use-timescale]: /use-timescale/:currentVersion:/
 [services-create]: /getting-started/:currentVersion:/services#create-your-timescale-account
 [services-connect]: /getting-started/:currentVersion:/services/#connect-to-your-service
+[run-queries-from-console]: /getting-started/:currentVersion:/run-queries-from-console/
 [ingest-data]: /getting-started/:currentVersion:/time-series-data/
 [queries]: /getting-started/:currentVersion:/queries/
 [caggs]: /getting-started/:currentVersion:/aggregation/

getting-started/page-index/page-index.js

@@ -9,6 +9,11 @@ module.exports = [
         href: "services",
         excerpt: "Create a Timescale service and connect to it",
       },
+      {
+        title: "Run your queries from Timescale Console",
+        href: "run-queries-from-console",
+        excerpt: "Run your queries securely from inside Timescale Console",
+      },
       {
         title: "Tables and hypertables",
         href: "tables-hypertables",

use-timescale/popsql.md renamed to getting-started/run-queries-from-console.md

@@ -1,12 +1,51 @@
 ---
-title: PopSQL
-excerpt: Use PopSQL to run SQL queries, create charts and dashboards, and collaborate with teammates.
+title: Run your queries from Timescale Console
+excerpt: Use PopSQL or SQL editor to run SQL queries, create charts and dashboards, and collaborate with teammates.
 keywords: [popsql, sql editor, chart, dashboard]
 ---
 
-# PopSQL
+# Run your queries from Timescale Console
 
-You use Timescale's [PopSQL](https://popsql.com) editor to write queries, visualize data, and share your results. 
+As Timescale Cloud is based on PostgreSQL, you can use lots of [different tools][integrations] to 
+connect to your service and interact with your data. To securely manage your date from inside 
+Console, Timescale offers the following Cloud SQL editors:
+
+- [SQL editor][run-sqleditor]: a simple UI to run queries for each individual service.
+- [PopSQL][run-popsql]: a comprehensive UI that you use to write queries, visualize data, 
+   and share your results.
+
+If you prefer the command line to a Cloud SQL editor, use [psql][install-psql].
+
+## SQL editor
+
+SQL editor is an integrated secure UI that you use to run queries and see the results 
+for an Timescale Cloud service.
+
+![Screenshot of SQL editor](https://assets.timescale.com/docs/images/sqleditor.png)
+
+To enable or disable SQL editor in your service, click `Operations` > `Service management`, then 
+update the setting for SQL editor.
+
+### Run queries from Console with SQL editor
+
+<Procedure>
+
+To use SQL editor with Timescale:
+
+1.  **Open SQL editor from Timescale Console**
+
+    1. In [Timescale Console][timescale-console-services], select a service.
+    1. Click `SQL editor`. You can now run queries for this service. 
+
+4. **Run a test query**
+
+    Type your query in the UI, then click `Run`. The results appear in the lower window. 
+
+</Procedure>
+
+## PopSQL
+
+You use [PopSQL](https://popsql.com) to write queries, visualize data, and share your results. 
 
 ![Screenshot of PopSQL](https://assets.timescale.com/docs/images/popsql_product_screenshot.png)
 
@@ -30,15 +69,14 @@ Available features are:
 - **[Query variables](https://docs.popsql.com/docs/query-variables)**: Use Liquid to
   parameterize your queries or use `if` statements.
 
+### Connect to your Timescale Cloud service with PopSQL 
 <Procedure>
 
-## Get started
-
 To use PopSQL with Timescale:
 
 1.  **Open PopSQL from Timescale Console**
 
-    Log in to [Timescale Console](https://console.cloud.timescale.com/), then click `PopSQL`. 
+    Log in to [Timescale Console][timescale-console], then click `PopSQL`. 
 
     ![PopSQL button within Timescale
     Console](https://assets.timescale.com/docs/images/popsql_button_in_console.png)
@@ -85,9 +123,9 @@ Now you have set up PopSQL, see how to easily do the following:
 
 
 
-## FAQ
+### PopSQL FAQ
 
-### How do I access PopSQL?
+#### How do I access PopSQL?
 
 Either:
 
@@ -104,7 +142,7 @@ Either:
   This resyncs your Timescale project with your PopSQL organization. Any new services are added automatically.
 
 
-### What if my service is within a VPC?
+#### What if my service is within a VPC?
 
 If your Timescale Service runs inside a VPC, do one of the following to enable access for PopSQL:
 
@@ -113,14 +151,14 @@ If your Timescale Service runs inside a VPC, do one of the following to enable a
   - When you configure the connection in PopSQL, under `Advanced Options`, enable `Connect over SSH`
 - Add PopSQL's static IPs (`23.20.131.72, 54.211.234.135`) to your allowlist
 
-### What happens if another member of my Timescale project opens PopSQL?
+#### What happens if another member of my Timescale project opens PopSQL?
 
 A PopSQL user account is created for the Timescale project member. This 
 user is automatically added to your PopSQL organization. Unless you 
 [share the connection within PopSQL](https://docs.popsql.com/docs/shared-connections), this 
 new user must input their own credentials for each service/connection.
 
-### Will using PopSQL affect the performance of my Timescale service?
+#### Will using PopSQL affect the performance of my Timescale Cloud service?
 
 There are a few factors to consider:
 
@@ -138,11 +176,20 @@ If you'd like to prevent write operations such as insert or update. Instead
 of using the `tsdbadmin` superuser, create a read-only user for your service and
 use that within PopSQL.
 
-### How does pricing work?
+## Cloud SQL editor seats
 
-Timescale customers get PopSQL Business for free for up to 10 users. To add more than 10 seats to your account, [Contact us](https://www.timescale.com/contact) for further assistance.  
+* **Timescale Cloud**: the number of Cloud SQL editor seats you are allocated depends on your 
+  [Pricing Plan][pricing-plan-features].
+* **PopSQL**: there is a free plan available to everyone, as well as paid plans. See  [PopSQL Pricing](https://popsql.com/pricing) for full 
+  details.
 
-PopSQL has a free plan available to everyone, as well as paid plans. See  [PopSQL Pricing](https://popsql.com/pricing) for full details.
 
 
-[readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/
+[readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/
+[run-popsql]: /getting-started/:currentVersion:/run-queries-from-console/#popsql
+[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
+[integrations]: /use-timescale/:currentVersion:/integrations/query-admin/
+[timescale-console]: https://console.cloud.timescale.com/
+[timescale-console-services]: https://console.cloud.timescale.com/dashboard/services
+[pricing-plan-features]: https://www.timescale.com/pricing#features
+[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/