DOC-295: Surrealist Doc revamp (#1221)

Author: Ekwuno

src/assets/img/image/cloud/change-instance-type-1.png

@@ -17,7 +17,7 @@ import InstanceCapabilities from "@img/image/cloud/instance-capabilities.png";
 
 # Configure an Instance
 
-You can configure your Instance in the Surreal Cloud dashboard by clicking on the **Configure** button on the Instance card.
+After you have created an Instance, you can configure it to your needs. This includes changing the Instance type, compute nodes, and capabilities. To do this, click on the **Configure Instance** button on the Instance card; this will open up a configuration drawer.
 
 <Image
 alt="Configure an Instance"
@@ -27,64 +27,51 @@ src={{
 	}}  
 />
 
-## Configuration options
+## Instance Configuration
 
-From the **Configure** modal, you can change the following settings:
+In the Instance configuration drawer, you can change the following settings:
 
+- **Capabilities**: the capabilities of the Instance, this controls the functionality available to users such as scripting, guest access, enabled endpoints for RPC and HTTP endpoints. You can also opt into beta features and restrict access to specific resources.
+- **Version**: the version of SurrealDB that will be used for the Instance. If you a new version is available, you will be prompted to upgrade and also see the release notes.
 - **Instance type**: the type of the Instance.
 - **Compute nodes**: the number of compute nodes to use.
-- **Capabilities**: the capabilities of the Instance.
 
-You can also access the Instance hostname and delete the Instance from this modal.
+### Instance capabilities
 
-### Instance type
+The capabilities you choose will determine the features available to your Instance. This includes scripting, guest access, enabled endpoints for RPC and HTTP and more. For RPC methods, HTTP endpoints and preview features, you can leave pick one of the following options:
 
-While the Instance type you choose will determine the compute and memory available to your Instance. When you hit the **0.25 vCPU** / **512MB memory** free tier limit, you can upgrade your plan to a higher tier using this option. 
+- **Managed default**: SurrealDB will manage the endpoints for you.
+- **Allow all by default**: All endpoints are allowed by default and you can then select which endpoints to deny.
+- **Deny all by default**: All endpoints are denied by default and you can then select which endpoints to allow.
 
-First, select the **Instance type** option which will open a modal to select the tier you want to upgrade to as shown below. Depending on the tier you choose, and the resources you have allocated, you will be billed accordingly.
+On the other hand network access and functions provide a more granular control over the endpoints. 
 
 <Image
-alt="Instance Type"
-src={{
-	light: InstanceType,
-	dark: InstanceType,
-	}}  
-/>
-
-<Image
-alt="Instance Type"
+alt="Configure an Instance"
 src={{
-	light: InstanceTypeModal,
-	dark: InstanceTypeModal,
+	light: InstanceCapabilities,
+	dark: InstanceCapabilities,
 	}}  
 />
 
+### Instance type
 
-### Compute nodes
-
-> [!NOTE]
-> In beta, you can only have 1 compute node. Customising compute nodes will be available soon.
-
-The number of compute nodes you choose will determine the number of Instances you can run on the same plan. For example, if you choose 2 compute nodes, you can run 2 Instances on the same plan.
-
-### Instance capabilities
-
-The capabilities you choose will determine the features available to your Instance. This includes scripting, guest access, enabled endpoints for RPC and HTTP and more.
+While the Instance type you choose will determine the compute and memory available to your Instance. When you hit the **0.25 vCPU** / **512MB memory** free tier limit, you can upgrade your plan to a higher tier using this option. 
 
-> [!IMPORTANT]
-> In beta, these Instance capabilities are read-only.
+First, select the **Instance type** option which will open a modal to select the tier you want to upgrade to as shown below. Depending on the tier you choose, and the resources you have allocated, you will be billed accordingly.
 
 <Image
-alt="Configure an Instance"
+alt="Instance Type"
 src={{
-	light: InstanceCapabilities,
-	dark: InstanceCapabilities,
+	light: InstanceType,
+	dark: InstanceType,
 	}}  
 />
 
-## Actions 
 
-If you run into an issue with your Instance, our support team is here to help. To help us resolve your issue, you'll need your hostname which can be copied by selecting the **copy hostname** button. You can also view your Instance usuage by selecting the **View usage** option.
+### Disk Size
+
+The disk size is the amount of storage available to your Instance. This is used to store the database files and can be increased at any time. For paid plans, you can increase the disk size up to the maximum limit of your plan.
 
 <Image
 alt="Instance Usage"
@@ -95,9 +82,12 @@ src={{
 />
 
 
-## Delete an Instance 
+## Pause or Delete an Instance 
+
+From the overview page, you can delete an Instance by clicking the option button on the Instance card and selecting **Delete**. This will bring up a confirmation modal. Once confirmed, the Instance will be deleted.
+
+To pause an Instance, click the option button on the Instance card and select **Pause**. This will bring up a confirmation modal. Once confirmed, the Instance will be paused.
 
-You can delete an Instance by clicking the **Delete** button on the Instance card. This will bring up a confirmation modal. Once confirmed, the Instance will be deleted and you will be redirected to the Instances page.
 
 <Image
 alt="Delete an Instance"

src/assets/img/image/cloud/configure-dark.png

@@ -6,7 +6,7 @@ description: Support offered by Surreal Cloud.
 ---
 import Image from "@components/Image.astro";
 
-import SurrealSidekickDark from '@img/image/cloud/surreal-sidekick.png';
+import SurrealSidekickDark from '@img/image/cloud/sidekick.png';
 
 # Support
 

src/assets/img/image/cloud/create-instance.png

@@ -10,7 +10,7 @@ description: In this section you will explore the connection options for Surreal
 You can connect to your Surreal Cloud instances in three main ways. In this section you will explore the following connection options:
 
 
-- [connect via Surrealist](/docs/cloud/connect/surrealist) : Surrealist is a query builder and IDE for SurrealDB. It allows you to connect to your Surreal Cloud Instance and run queries in a graphical interface.
+- [querying in Surrealist](/docs/cloud/connect/surrealist) : Surrealist is a query builder and IDE for SurrealDB. It allows you to connect to your Surreal Cloud Instance and run queries in a graphical interface.
 - [connect via CLI](/docs/cloud/connect/cli) : using the command-line interface for SurrealDB, you can connect to your Surreal Cloud Instance and run queries in a command-line interface.
 - [connect via SDK](/docs/cloud/connect/sdk) : Surreal Cloud supports a variety of SDKs for connecting to your Instance. You can use the SDKs to connect to your Instance and run queries in your preferred programming language.
 - [connect via HTTP](/docs/cloud/connect/http) : Surreal Cloud supports a REST API for connecting to your Instance. You can use the API to connect to your Instance and run queries using CURL or any HTTP client.

src/assets/img/image/cloud/create-root-user.png

@@ -32,7 +32,9 @@ After you have selected your SDK, you will need to provide your connection detai
 
 ## Enter connection details
 
-When using any of the SurrealDB SDKs, before you can start querying your Surreal Cloud Instance, you will need to provide your connection details. SurrealDB requires **namespace** & **database** details so that it knows where to run and store your data. Learn more about [namespaces](/docs/surrealdb/introduction/concepts/namespace) and [databases](/docs/surrealdb/introduction/concepts/database) in the SurrealDB documentation.
+When using any of the SurrealDB SDKs, before you can start querying your Surreal Cloud Instance, you will need to provide your connection details. SurrealDB requires **namespace** & **database** details so that it knows where to run and store your data. On the top of the dashboard, you can find the prompt to create a namespace and database.
+
+Learn more about [namespaces](/docs/surrealdb/introduction/concepts/namespace) and [databases](/docs/surrealdb/introduction/concepts/database) in the SurrealDB documentation.
 
 
 

src/assets/img/image/cloud/delete-instance.png

@@ -1,8 +1,8 @@
 ---
 sidebar_position: 2
-sidebar_label: Connect via Surrealist
-title: Connect via Surrealist | Surreal Cloud
-description: Connect to your Surreal Cloud instance using Surrealist.
+sidebar_label: Querying in Surrealist
+title: Querying in Surrealist | Surreal Cloud
+description: Query your Surreal Cloud instance using Surrealist.
 ---
 
 import Image from "@components/Image.astro";
@@ -16,25 +16,13 @@ import NamespaceDatabaseDark from '@img/image/cloud/namespace-database.png';
 import QueryingInstanceLight from '@img/image/cloud/querying-instance.png';
 import QueryingInstanceDark from '@img/image/cloud/querying-instance.png';
 
-# Connect via Surrealist
+# Querying in Surrealist
 
-Once you have created a Surreal Cloud Instance, you can connect to it in Surrealist, which allows you to interact with your created Cloud Instance from the [query view in Surrealist](/docs/surrealist/concepts/sending-queries).
+Once you have created a Surreal Cloud Instance, you can start querying it in Surrealist in the [query view](/docs/surrealist/concepts/sending-queries).
 
-Start by clicking the **Connect** button on your Instance. Then select the **Open in Surrealist** option in the connection modal. This will open the Surrealist query view.
+In the query view, and before you can run queries in Surrealist, you need to select a [Namespace](/docs/surrealdb/introduction/concepts) and a [Database](/docs/surrealdb/introduction/concepts) to work in.
 
-<Image
-alt="Open in Surrealist"
-src={{
-	light: OpenInSurrealistLight,
-	dark: OpenInSurrealistDark,
-	}}
-/>
-
-## Querying your Instance 
-
-Once in the query view, and before you can run queries in Surrealist, you need to select a [Namespace](/docs/surrealdb/introduction/concepts) and a [Database](/docs/surrealdb/introduction/concepts) to work in.
-
-First click on the **Namespace** dropdown and select the namespace you want to work in (if you have not created a namespace, you will see an option to create one). Then click on the **Database** dropdown and select the database you want to work in.
+First click on the **Namespace** button and select the namespace you want to work in (if you have not created a namespace, you will see an option to create one). Then click on the **Database** button and select the database you want to work in (if you have not created a namespace, you will see an option to create one).
 
 <Image
 alt="Namespace and Database"

src/assets/img/image/cloud/instance-capabilities.png

@@ -17,25 +17,24 @@ Surreal Cloud allows you to create a new Instance with a few clicks. You can cre
 > [!IMPORTANT]
 > In Beta, you can create instances only in a personal account. Support for creating instances in organizations is coming soon.
 
-You can create an Instance in these steps from your Cloud dashboard:
+You can create an Instance in these steps from the overview:
 
-1. Click on the **Create Instance** button.
-    - You can choose to create a new Instance either in your personal account or in an organization.
-    - If you choose to create an Instance in an organization, you need to select the organization from the dropdown list.
+1. Click on the **Create new** button and select the **Cloud Instance** option. This will take you to the create instance form.
 
 2. Input your Instance details.
-    - **Instance name**: the name of the Instance.
-    - **Instance version**: the version of SurrealDB you want to use. In the Beta release, only version `>v2.0.0` is available to use as it is the latest stable release. 
-
-3. Select a region where you want to deploy your Instance.
-    - AWS Europe (Ireland)
-    - AWS US East (N. Virginia)
+    - **Organization**: the organization you want to create the Instance in. 
+    - **Configuration**: the configuration you want to use for your Instance.
+        - **Instance name**: the name of the Instance.
+        - **Region**: the region you want to deploy your Instance in. 
+            - AWS Europe (Ireland)
+            - AWS US East (N. Virginia)
+        - **SurrealDB version**: the version of SurrealDB you want to use. Only versions `>v2.0.0` are available to use. If you are unsure, select the latest version but if you select a lower version, you will be able to upgrade to the latest in your Instance settings.
 
 > [!IMPORTANT]
 > The region you choose will affect your application's latency. For optimal performance, choose a region that is closest to your users.
 
 
-4. Select an Instance category: Instance category defines the resources allocated to your cloud Instance. The Instance categories are in three different categories - **Development**, **Production**, and **Free Tier**. You can choose between the following configurations:
+4. Select an Instance type: Instance type defines the resources allocated to your cloud Instance. The Instance types are in three different categories - **Development**, **Production**, and **Free Tier**. You can choose between the following configurations:
 
 > [!NOTE]
 > To use a Production or Development Instance, you need to enter your billing and payment information.
@@ -62,12 +61,8 @@ src={{
 	}}  
 />
 
-5. Choose nodes: the number of nodes selected will define the number of compute nodes allocated to your Instance.
-
-> [!IMPORTANT]
-> The number of nodes you choose will affect the cost of your Instance.
 
-6. After customising your Instance, click the **Create** button. You will see a confirmation message with the details of your Instance. You can now connect to your Instance using your [preferred connection method](/docs/cloud/connect).
+6. After customising your Instance, click the **Create Instance** button. You will see a confirmation message with the details of your Instance. You can now connect to your Instance using your [preferred connection method](/docs/cloud/connect).
 
 
 ## Next steps

src/assets/img/image/cloud/namespace-database.png

@@ -8,7 +8,7 @@ description: In this section, you will explore using SurrealQL, a powerful datab
 import Image from "@components/Image.astro";
 import LightLogo from "@img/icon/light/surrealql.png";
 import DarkLogo from "@img/icon/dark/surrealql.png";
-import ImageSurrealist from "@img/image/surrealist/query.png";
+import ImageSurrealist from "@img/image/surrealist/query-new.png";
 
 <Image
     alt="QL"

src/assets/img/image/cloud/open-in-cli.png

@@ -19,7 +19,7 @@ Surrealist can be added to any website or application using Embeds. This lets yo
 
 ## Creating a new Embed
 
-To create an embed, first head over to the [Surrealist embed generator](https://surrealist.app/mini/new). Then, in the `Editor query` section, you can write the query you want to be embedded. If the query uses variables, you can enter the values for the variables in the `Editor variables` section, and they will appear in the Embed preview section on the right.
+To create an embed, head over to the surrealist overview page and click on the embed surrealist option. Then, in the `Editor query` section, you can write the query you want to be embedded. If the query uses variables, you can enter the values for the variables in the `Editor variables` section, and they will appear in the Embed preview section on the right.
 
 ### Setup query
 

src/assets/img/image/cloud/open-in-http.png

@@ -24,7 +24,7 @@ As the name implies, the tables panel will list out all tables in the database.
 
 
 > [!NOTE]
-> In the Designer view section we will explain more in-depth about what constitutes tables as normal or edge tables.
+> In the [Designer view](/docs/surrealist/concepts/designing-the-database-schema) section we will explain more in-depth about what constitutes tables as normal or edge tables.
 
 ### Record explorer panel
 

src/assets/img/image/cloud/open-in-sdk.png

@@ -6,7 +6,7 @@ description: Surrealist is a user interface for interacting with your SurrealDB
 ---
 
 import Image from "@components/Image.astro";
-import ImageQuery from "@img/image/surrealist/query.png";
+import ImageQuery from "@img/image/surrealist/query-new.png";
 
 # Sending queries to the database
 
@@ -17,6 +17,9 @@ The first view you encounter when starting Surrealist is the Query view. At its
   src={ImageQuery}
 />
 
+> [!NOTE]
+> The example above shows writing a query to a sandbox connection where no credentials are required. When connecting to a Surreal Cloud instance or a local connection, you will need to enter your namespace and database credentials in the connection dialog before you can send queries.
+
 ## Queries panel
 
 The panel on the left of the Query view lists out your active query tabs. Each tab has its own query editor, so you can work with multiple queries at once and keep your workspace organised. You can double-click a tab to rename it, and right-click a tab to reveal additional actions.
@@ -45,7 +48,9 @@ After executing a query the result of the query will be displayed in the results
 
 - **Combined mode**: will list all query responses in a single list. This is especially useful for requests with only a handful of statements or when you would like to view all responses at a glance.
 
-- **Single mode**: will display each response separately and provide navigation buttons to switch between them. This is mostly useful when you are sending many queries at once or would like to focus on each response individually.
+- **Individual mode**: will display each response separately and provide navigation buttons to switch between them. This is mostly useful when you are sending many queries at once or would like to focus on each response individually.
+
+- **Graph mode**: will display the response as a graph if they are compatible with the response i.e is a list of records with relations. This is useful for visualising the relationships between records.
 
 - **Table mode**: presents your responses in an interactive table similar to the Explorer view. You can press any record id to view and edit the record in the inspector panel.