From fecde1316cf3d3f481c736aadbe8547b8f1b025b Mon Sep 17 00:00:00 2001 From: Ivan Despot <66276597+g-despot@users.noreply.github.com> Date: Thu, 6 Aug 2026 19:39:45 +0200 Subject: [PATCH] docs(cloud): remove dead imports, add the missing default-index row, fix typos Seventeen imports left over from a migration that replaced screenshots with iframes were referencing assets no page rendered. One of them was a downtime warning. It was never rendered on this page, and it is no longer true for RBAC-enabled clusters, which manage users at runtime, so rendering it would have told readers that routine key rotation costs downtime. The import is removed and the now-unreferenced include deleted. The database settings table omitted DEFAULT_VECTOR_INDEX even though the Optimization profile section is entirely about which index becomes the default. The new row deliberately states no single value, because for Cloud there isn't one: it points at the profile and the note explains the mapping. Also an invalid JSON response block, and 'Select you' for 'your' twice. --- docs/cloud/manage-clusters/authentication.mdx | 5 ---- docs/cloud/manage-clusters/authorization.mdx | 8 ------- docs/cloud/manage-clusters/connect.mdx | 6 ++--- .../manage-clusters/default-settings.mdx | 9 ++++++++ docs/cloud/platform/create-account.mdx | 4 +--- docs/cloud/platform/multi-factor-auth.mdx | 5 +--- .../platform/users-and-organizations.mdx | 2 +- docs/cloud/quickstart.mdx | 23 ++++++++----------- docs/cloud/tools/collections-tool.mdx | 4 ++-- 9 files changed, 25 insertions(+), 41 deletions(-) diff --git a/docs/cloud/manage-clusters/authentication.mdx b/docs/cloud/manage-clusters/authentication.mdx index 5a88fc1ad..134938234 100644 --- a/docs/cloud/manage-clusters/authentication.mdx +++ b/docs/cloud/manage-clusters/authentication.mdx @@ -5,11 +5,6 @@ description: "Configure authentication options for Weaviate Cloud clusters by ad image: og/wcd/user_guides.jpg --- -import WCDAPIKeys from "/docs/cloud/img/wcs-api-keys.jpg"; -import WCDAddAPIKeys from "/docs/cloud/img/wcs-add-key-details.jpg"; -import WCDDelAPIKeys from "/docs/cloud/img/wcs-delete-api-key.jpg"; -import RestartTheCluster from "/_includes/wcs/restart-warning.mdx"; - [Weaviate Cloud (WCD)](/go/console?utm_content=cloud) uses [RBAC (Role-Based Access Control)](/weaviate/configuration/rbac/index.mdx) to manage authentication. Below, you can find guides on how to create, edit, rotate and delete API keys for accessing Weaviate Cloud. ### Create an API key diff --git a/docs/cloud/manage-clusters/authorization.mdx b/docs/cloud/manage-clusters/authorization.mdx index 2c77ed8fb..da3aa1dea 100644 --- a/docs/cloud/manage-clusters/authorization.mdx +++ b/docs/cloud/manage-clusters/authorization.mdx @@ -5,14 +5,6 @@ description: "Role-Based Access Control (RBAC) configuration guide for Weaviate image: og/wcd/user_guides.jpg --- -import Link from "@docusaurus/Link"; -import WCDCreateRole from "/docs/cloud/img/weaviate-cloud-roles-create.png"; -import WCDCreateRoleForm from "/docs/cloud/img/weaviate-cloud-roles-create-form.png"; -import WCDEditRole from "/docs/cloud/img/weaviate-cloud-roles-edit.png"; -import WCDEditRoleForm from "/docs/cloud/img/weaviate-cloud-roles-edit-form.png"; -import WCDDeleteRole from "/docs/cloud/img/weaviate-cloud-roles-delete.png"; -import WCDDeleteRoleForm from "/docs/cloud/img/weaviate-cloud-roles-delete-form.png"; - [Weaviate Cloud (WCD)](/go/console?utm_content=cloud) uses [RBAC (Role-Based Access Control)](/weaviate/configuration/rbac/index.mdx) to manage authorization. Below, you can find guides on how to create, edit and delete user roles and manage their permissions. ## Create a role diff --git a/docs/cloud/manage-clusters/connect.mdx b/docs/cloud/manage-clusters/connect.mdx index 3af28250b..9dccf634e 100644 --- a/docs/cloud/manage-clusters/connect.mdx +++ b/docs/cloud/manage-clusters/connect.mdx @@ -6,8 +6,6 @@ description: "Multiple connection options and methods for accessing your Weaviat image: og/wcd/user_guides.jpg --- -import CompareURLs from "/docs/cloud/img/wcs-console-url-check.jpg"; - [Weaviate Cloud (WCD)](/go/console?utm_content=cloud) offers multiple options on how to connect to your cluster: - **[Connect with APIs](#connect-with-an-api-programmatically)**: @@ -147,7 +145,7 @@ This section has solutions for some common problems. For additional help, [conta To reset your Weaviate Cloud password, follow these steps: 1. Go to the Weaviate Cloud [login page](/go/console?utm_content=cloud). -1. Click on click the login button. +1. Click the login button. 1. Click `Forgot Password`. 1. Check your email account for a password reset email from Weaviate Cloud. 1. Click the link and follow the instructions to reset your password. The link is only valid for five minutes. @@ -195,7 +193,7 @@ weaviate.exceptions.WeaviateGRPCUnavailableError: gRPC health check could not be **Solution**: Verify the cluster URL is correct and update the URL if needed. -When a Shared Cloud cluster is updated, the cluster URL may change slightly. Weaviate Cloud still routes the old URL, so some connections work, however the new gRPC and the old HTTP URLS are different so connections that require gRCP fail. +When a Shared Cloud cluster is updated, the cluster URL may change slightly. Weaviate Cloud still routes the old URL, so some connections work, however the new gRPC and the old HTTP URLs are different so connections that require gRPC fail. To check the URLs, open the Weaviate Cloud Console and check the details panel for your cluster. If you prefix Cluster URL with `grpc-`, the Cluster URL and the Cluster gRPC URL should match. Compare the Cluster URL with the connection URL in your application. The old URL and the new URL are similar, but the new one may have an extra subdomain such as `.c0.region`. If the URLs are different, update your application's connection code to use the new Cluster URL. diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx index 7d269b151..7e8dd9a40 100644 --- a/docs/cloud/manage-clusters/default-settings.mdx +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -22,6 +22,7 @@ import AdvancedOptions from "/docs/cloud/img/weaviate-cloud-cluster-advanced-set | [`ASYNC_REPLICATION_DISABLED`](/deploy/configuration/env-vars/index.md#ASYNC_REPLICATION_DISABLED) | No | false | No | | [`ASYNC_INDEXING`](/deploy/configuration/env-vars/index.md#ASYNC_INDEXING) | Yes | true | No | | [`DEFAULT_QUANTIZATION`](/deploy/configuration/env-vars/index.md#DEFAULT_QUANTIZATION) | No | [RQ-8](/weaviate/configuration/compression/rq-compression.md) | Yes (1) | +| [`DEFAULT_VECTOR_INDEX`](/deploy/configuration/env-vars/index.md#DEFAULT_VECTOR_INDEX) | No | Set by the cluster's [optimization profile](/cloud/manage-clusters/create#optimization-profile) | Yes (via the optimization profile) | | `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes (to allow any) (3) | | [`REPLICATION_MINIMUM_FACTOR`](/deploy/configuration/env-vars/index.md#REPLICATION_MINIMUM_FACTOR) | Yes | 3 (for HA clusters) | No | @@ -37,6 +38,14 @@ import AdvancedOptions from "/docs/cloud/img/weaviate-cloud-cluster-advanced-set
+:::note Default vector index and the optimization profile + +`DEFAULT_VECTOR_INDEX` is not set directly. It is determined by the [optimization profile](/cloud/manage-clusters/create#optimization-profile) you pick when you create the cluster: the `Cost Optimized` profile makes HFresh the default vector index, and the `Performance Optimized` profile makes HNSW the default. Free clusters support the `Cost Optimized` profile only. + +The profile only sets the default for new collections. An explicit vector index in a [collection definition](/weaviate/manage-collections/vector-config) always takes precedence. + +::: + ## User management & permissions These settings control authentication and authorization for your cluster. These settings are not user configurable. diff --git a/docs/cloud/platform/create-account.mdx b/docs/cloud/platform/create-account.mdx index 73489f8e3..9ffc572b1 100644 --- a/docs/cloud/platform/create-account.mdx +++ b/docs/cloud/platform/create-account.mdx @@ -5,8 +5,6 @@ description: "How to create and delete user accounts in the Weaviate Cloud conso image: og/wcd/user_guides.jpg --- -import LandingRegister from "/docs/cloud/img/wcs-landing-page-register.jpg"; - Weaviate Cloud (WCD) offers an interactive console. Create a user account, then login to manage WCD clusters, run queries, and configure your organization details. ## Create a new user account and sign in {#create-a-new-user-account} @@ -57,7 +55,7 @@ To delete your account from Weaviate Cloud (WCD): 1. Remove organization members: If you own an organization, you must remove all other members from it first. 2. Navigate to the [Account Page](https://console.weaviate.cloud/account). -4. In the **Danger Zone** section, click **Delete Account** to permanently remove your account. +3. In the **Danger Zone** section, click **Delete Account** to permanently remove your account. If you encounter any issues, please contact our [Weaviate Support](https://support.weaviate.io). diff --git a/docs/cloud/platform/multi-factor-auth.mdx b/docs/cloud/platform/multi-factor-auth.mdx index 9a61a531d..e5103ed6d 100644 --- a/docs/cloud/platform/multi-factor-auth.mdx +++ b/docs/cloud/platform/multi-factor-auth.mdx @@ -5,9 +5,6 @@ description: "Enhanced security setup with multi-factor authentication for Weavi image: og/wcd/user_guides.jpg --- -import MFAOneTime from "/docs/cloud/img/mfa-one-time-code.jpg"; -import MFAEnableIcon from "/docs/cloud/img/mfa-enable-icon.jpg"; - Multi-factor authentication (MFA) increases the security of browser logins. MFA is not enabled by default. ## Enable multi-factor authentication @@ -85,7 +82,7 @@ To disable MFA, [contact support](https://support.weaviate.io). If you use a JavaScript/TypeScript client to connect a browser hosted application to Weaviate, do not enable MFA for that client's account. -There is no way to pass the the one-time authentication code to the application, so the application cannot connect to Weaviate Cloud. +There is no way to pass the one-time authentication code to the application, so the application cannot connect to Weaviate Cloud. Use API keys to connect browser based client applications to Weaviate Cloud. diff --git a/docs/cloud/platform/users-and-organizations.mdx b/docs/cloud/platform/users-and-organizations.mdx index 11cda7894..70891e6ea 100644 --- a/docs/cloud/platform/users-and-organizations.mdx +++ b/docs/cloud/platform/users-and-organizations.mdx @@ -22,7 +22,7 @@ Organizations group user accounts together. An organization owns its clusters an - Organization management - Billing configuration -Be cautious when granting elevated roles (`Owner`, `Admin`) in production — those users can modify the organization, its clusters, and its billing. +Be cautious when granting elevated roles (`Owner`, `Admin`) in production. Those users can modify the organization, its clusters, and its billing. ## Manage organizations {#manage-organizations} diff --git a/docs/cloud/quickstart.mdx b/docs/cloud/quickstart.mdx index dd4548c27..0897533c7 100644 --- a/docs/cloud/quickstart.mdx +++ b/docs/cloud/quickstart.mdx @@ -7,9 +7,6 @@ image: og/docs/quickstart-tutorial.jpg # tags: ['getting started'] --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - Expected time: 30 minutes

@@ -254,20 +251,18 @@ import QueryNearText from "/_includes/code/quickstart/quickstart.query.neartext. Run this code to perform the query. Our query found entries for `DNA` and `species`.
- Example full response in JSON format + Example response ```json { - { - "answer": "DNA", - "question": "In 1953 Watson & Crick built a model of the molecular structure of this, the gene-carrying substance", - "category": "SCIENCE" - }, - { - "answer": "species", - "question": "2000 news: the Gunnison sage grouse isn't just another northern sage grouse, but a new one of this classification", - "category": "SCIENCE" - } + "answer": "DNA", + "question": "In 1953 Watson & Crick built a model of the molecular structure of this, the gene-carrying substance", + "category": "SCIENCE" +} +{ + "answer": "species", + "question": "2000 news: the Gunnison sage grouse isn't just another northern sage grouse, but a new one of this classification", + "category": "SCIENCE" } ``` diff --git a/docs/cloud/tools/collections-tool.mdx b/docs/cloud/tools/collections-tool.mdx index 546e26afd..60be49aac 100644 --- a/docs/cloud/tools/collections-tool.mdx +++ b/docs/cloud/tools/collections-tool.mdx @@ -292,10 +292,10 @@ Some collection settings that are not available in the console can be updated pr Enable TTL step by step 1. Open the [Weaviate Cloud console](/go/console?utm_content=cloud). -2. Select you organization and cluster in the left sidebar. +2. Select your organization and cluster in the left sidebar. 3. Open the `Collections` tool from the left sidebar and select the collection you want to modify. 4. Click the pencil icon next to the Time to live (TTL) field. -5. Select you desired [TTL settings](/weaviate/manage-collections/time-to-live.mdx) and save them. +5. Select your desired [TTL settings](/weaviate/manage-collections/time-to-live.mdx) and save them.