From e3025cb3aa2f169471cf4e23eac04f5f21b2e9fa Mon Sep 17 00:00:00 2001 From: Shan-Weaviate <137914800+Shan-Weaviate@users.noreply.github.com> Date: Thu, 27 Nov 2025 12:58:07 +0000 Subject: [PATCH 1/6] Update --- _includes/wcs/wcs-landing-get-started.mdx | 5 +- _includes/wcs/wcs-landing-intro.mdx | 2 +- .../wcs/weaviate-cloud-edit-organization.mdx | 11 +- .../tutorial-recipe-recommender.mdx | 26 +-- docs/agents/personalization/usage.md | 19 +- docs/agents/query/tutorial-ecommerce.mdx | 2 +- docs/agents/query/usage.md | 2 +- .../tutorial-enrich-dataset.mdx | 6 +- docs/agents/transformation/usage.md | 7 +- docs/cloud/embeddings/administration.md | 6 +- docs/cloud/faq.mdx | 6 +- docs/cloud/manage-clusters/authentication.mdx | 22 ++- docs/cloud/manage-clusters/authorization.mdx | 28 +-- docs/cloud/manage-clusters/connect.mdx | 8 +- docs/cloud/manage-clusters/create.mdx | 6 +- docs/cloud/manage-clusters/status.mdx | 25 ++- docs/cloud/manage-clusters/upgrade.mdx | 6 +- docs/cloud/platform/create-account.mdx | 12 +- docs/cloud/platform/multi-factor-auth.mdx | 34 ++-- docs/cloud/platform/support-levels.mdx | 2 +- .../platform/users-and-organizations.mdx | 79 +++++--- docs/cloud/platform/version.mdx | 6 +- docs/cloud/quickstart.mdx | 34 ++-- docs/cloud/tools/query-tool.mdx | 22 ++- docs/contributor-guide/weaviate-core/setup.md | 14 +- docs/deploy/configuration/authentication.md | 31 +-- docs/deploy/index.mdx | 2 +- docs/deploy/installation-guides/index.md | 7 +- ...gent-workflow-with-weaviate-query-agent.md | 12 +- .../recipes/crewai-query-agent-as-tool.md | 9 +- .../recipes/haystack-query-agent-tool.md | 9 +- docs/weaviate/api/graphql/explore.md | 10 +- docs/weaviate/api/grpc.md | 8 +- .../_components/client.auth.wcs.mdx | 2 +- docs/weaviate/concepts/interface.md | 69 +++---- .../_enterprise-usage-collector.md | 38 ++-- .../compression/pq-compression.md | 2 +- docs/weaviate/connections/connect-cloud.mdx | 4 +- docs/weaviate/connections/connect-query.mdx | 18 +- .../model-providers/weaviate/index.md | 4 +- docs/weaviate/quickstart/index.md | 68 +++---- .../recipes/hybrid_search_mistral_embed.md | 13 +- .../recipes/multi-vector-colipali-rag.md | 43 ++++- .../rag_llama_3.1_nemotron_51b_instruct.md | 23 ++- .../recipes/weaviate_embeddings_service.md | 25 ++- .../weaviate/starter-guides/which-weaviate.md | 11 +- docs/weaviate/tutorials/_console.md | 18 +- .../weaviate/tutorials/collection-aliases.mdx | 2 +- docs/weaviate/tutorials/import.mdx | 2 +- .../tutorials/multi-vector-embeddings.md | 15 +- docs/weaviate/tutorials/query.md | 181 +++++++++--------- .../tutorials/vectorizer-migration.mdx | 4 +- docusaurus.config.js | 5 +- src/components/UTM/capture.js | 51 +++++ src/pages/go/console.jsx | 72 +++++++ 55 files changed, 705 insertions(+), 443 deletions(-) create mode 100644 src/components/UTM/capture.js create mode 100644 src/pages/go/console.jsx diff --git a/_includes/wcs/wcs-landing-get-started.mdx b/_includes/wcs/wcs-landing-get-started.mdx index baae663fc..438a20837 100644 --- a/_includes/wcs/wcs-landing-get-started.mdx +++ b/_includes/wcs/wcs-landing-get-started.mdx @@ -5,8 +5,9 @@ import CardsSection from "/src/components/CardsSection"; export const nextStepsData = [ { title: "Weaviate Cloud: Console", - description: " Go directly to the Weaviate Cloud console and create your first cluster.", - link: "https://weaviate.io/go/console?utm_source=docs&utm_content=others", + description: + " Go directly to the Weaviate Cloud console and create your first cluster.", + link: "/go/console?utm_source=docs&utm_content=others", icon: "fa fa-desktop", }, { diff --git a/_includes/wcs/wcs-landing-intro.mdx b/_includes/wcs/wcs-landing-intro.mdx index 6781c7c86..eaa4953d3 100644 --- a/_includes/wcs/wcs-landing-intro.mdx +++ b/_includes/wcs/wcs-landing-intro.mdx @@ -1,3 +1,3 @@ -**[Weaviate Cloud (WCD)](https://weaviate.io/go/console?utm_source=docs&utm_content=others)** is a fully managed vector database in the cloud. +**[Weaviate Cloud (WCD)](/go/console?utm_source=docs&utm_content=others)** is a fully managed vector database in the cloud. Weaviate Cloud manages the infrastructure so you can focus on innovation. Use Weaviate Cloud to simplify development and confidently deploy enterprise-ready AI applications. diff --git a/_includes/wcs/weaviate-cloud-edit-organization.mdx b/_includes/wcs/weaviate-cloud-edit-organization.mdx index 59a20b57f..4ba6e69d3 100644 --- a/_includes/wcs/weaviate-cloud-edit-organization.mdx +++ b/_includes/wcs/weaviate-cloud-edit-organization.mdx @@ -1,12 +1,15 @@ -import Link from '@docusaurus/Link'; -import OrganizationSettings from '/docs/cloud/img/weaviate-cloud-organization-settings.png'; +import Link from "@docusaurus/Link"; +import OrganizationSettings from "/docs/cloud/img/weaviate-cloud-organization-settings.png";
  1. - Open the{' '} - Weaviate Cloud console. + Open the{" "} + + Weaviate Cloud console + + .
  2. Open the organization dropdown menu (1). diff --git a/docs/agents/personalization/tutorial-recipe-recommender.mdx b/docs/agents/personalization/tutorial-recipe-recommender.mdx index 230dad5c6..69feb5de4 100644 --- a/docs/agents/personalization/tutorial-recipe-recommender.mdx +++ b/docs/agents/personalization/tutorial-recipe-recommender.mdx @@ -1,23 +1,23 @@ --- title: Build a recipe recommender with the Personalization Agent -sidebar_label: 'Tutorial: Recipe recommender' +sidebar_label: "Tutorial: Recipe recommender" description: "Tutorial for creating a recipe recommendation system using the Personalization Agent." sidebar_position: 40 image: og/docs/tutorials.jpg # tags: ['personalization', 'recommendation'] --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; -import PyCode from '!!raw-loader!/docs/agents/_includes/personalization_agent_tutorial_food_recommender.py'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBlock"; +import PyCode from "!!raw-loader!/docs/agents/_includes/personalization_agent_tutorial_food_recommender.py"; :::caution Technical Preview -![This Weaviate Agent is in technical preview.](../_includes/agents_tech_preview_light.png#gh-light-mode-only 'This Weaviate Agent is in technical preview.') -![This Weaviate Agent is in technical preview.](../_includes/agents_tech_preview_dark.png#gh-dark-mode-only 'This Weaviate Agent is in technical preview.') +![This Weaviate Agent is in technical preview.](../_includes/agents_tech_preview_light.png#gh-light-mode-only "This Weaviate Agent is in technical preview.") +![This Weaviate Agent is in technical preview.](../_includes/agents_tech_preview_dark.png#gh-dark-mode-only "This Weaviate Agent is in technical preview.") [Sign up here](https://events.weaviate.io/weaviate-agents) for notifications on Weaviate Agents, or visit [this page](https://weaviateagents.featurebase.app/) to see the latest updates and provide feedback. @@ -38,7 +38,7 @@ It is available on HuggingFace: The Weaviate Personalization Agent is a pre-built agentic service designed to retrieve objects from a Weaviate collection in a way that is tailored to individual users. It achieves this by considering a user's defined persona (profile) and their history of interactions with items in the collection. -import WeaviateAgentsPersonalizationFoodFlowchart from '/docs/agents/_includes/personalization_agent_tutorial_food_recommender_flowchart.png'; +import WeaviateAgentsPersonalizationFoodFlowchart from "/docs/agents/_includes/personalization_agent_tutorial_food_recommender_flowchart.png";
    @@ -64,7 +64,7 @@ The Personalization Agent: ## Prerequisites -To use the Weaviate Agents and Weaviate Embedding service, you need to have a **[Weaviate Cloud](https://weaviate.io/go/console?utm_source=docs&utm_content=agents)** account. +To use the Weaviate Agents and Weaviate Embedding service, you need to have a **[Weaviate Cloud](/go/console?utm_source=docs&utm_content=agents)** account. ## Step 1: Set up Weaviate @@ -106,7 +106,7 @@ pip install datasets -import ForcePipInstall from '../_includes/_force_pip_install.mdx'; +import ForcePipInstall from "../_includes/_force_pip_install.mdx"; @@ -135,7 +135,7 @@ In the following code blocks, we will pull our demo recipe dataset from Hugging Below you can see what the objects in the `Recipes` dataset look like. -import WeaviateAgentsPersonalizationFoodDataset from '/docs/agents/_includes/personalization_agent_tutorial_food_recommender_dataset.png'; +import WeaviateAgentsPersonalizationFoodDataset from "/docs/agents/_includes/personalization_agent_tutorial_food_recommender_dataset.png";
    @@ -242,7 +242,7 @@ Feel free to modify the example below to represent your own food preferences\! Each `PersonaInteraction` links a `persona_id` to an `item_id` (the UUID of an object in the "Recipes" collection) and includes a `weight` from -1.0 (strong dislike) to 1.0 (strong like). -import WeaviateAgentsPersonalizationFoodUser from '/docs/agents/_includes/personalization_agent_tutorial_food_recommender_user.png'; +import WeaviateAgentsPersonalizationFoodUser from "/docs/agents/_includes/personalization_agent_tutorial_food_recommender_user.png";
    @@ -368,6 +368,6 @@ The Personalization Agent allows you to easily add sophisticated, personalized r The official changelog for Weaviate Agents can be [found here](https://weaviateagents.featurebase.app/changelog). If you have feedback, such as feature requests, bug reports or questions, please [submit them here](https://weaviateagents.featurebase.app/), where you will be able to see the status of your feedback and vote on others' feedback. ::: -import DocsFeedback from '/_includes/docs-feedback.mdx'; +import DocsFeedback from "/_includes/docs-feedback.mdx"; diff --git a/docs/agents/personalization/usage.md b/docs/agents/personalization/usage.md index 6f258457d..b205781c8 100644 --- a/docs/agents/personalization/usage.md +++ b/docs/agents/personalization/usage.md @@ -9,7 +9,7 @@ image: og/docs/agents.jpg import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; -import PyCode from '!!raw-loader!/docs/agents/_includes/personalization_agent.py'; +import PyCode from '!!raw-loader!/docs/agents/\_includes/personalization_agent.py'; # Weaviate Personalization Agent: Usage @@ -24,7 +24,6 @@ import PyCode from '!!raw-loader!/docs/agents/_includes/personalization_agent.py ::: - The Weaviate Personalization Agent is an agentic service designed to return personalized recommendations tailored to each user. The Personalization Agent uses data from the associated Weaviate Cloud instance to provide these recommendations. :::tip Nomenclature: User vs Developer @@ -50,7 +49,7 @@ This Agent is available exclusively for use with a Weaviate Cloud instance. Refer to the [Weaviate Cloud documentation](/cloud/index.mdx) for more information on how to set up a Weaviate Cloud instance. -You can try this Weaviate Agent with a free Sandbox instance on [Weaviate Cloud](https://weaviate.io/go/console?utm_source=docs&utm_content=agents). +You can try this Weaviate Agent with a free Sandbox instance on [Weaviate Cloud](/go/console?utm_source=docs&utm_content=agents). ### Client library @@ -97,6 +96,7 @@ To use the Personalization Agent, follow the below high-level steps: - Obtain personalized recommendations Optionally, the personalization agent can: + - Perform reranking of the results - With a further option of custom instructions for the reranking @@ -166,14 +166,14 @@ You can delete or update an existing user persona, as well as to check if a user To delete a user persona, specify the user ID of the persona to be deleted. - - + - + #### Update a user persona @@ -308,8 +308,8 @@ In addition to the response objects, the response may include the following info - Rationale for the recommendations - For each object: - - Original rank of the item - - Personalized rank of the item + - Original rank of the item + - Personalized rank of the item @@ -395,7 +395,6 @@ The combined Weaviate query and personalization agent query is not available for The official changelog for Weaviate Agents can be [found here](https://weaviateagents.featurebase.app/changelog). If you have feedback, such as feature requests, bug reports or questions, please [submit them here](https://weaviateagents.featurebase.app/), where you will be able to see the status of your feedback and vote on others' feedback. ::: -import DocsFeedback from '/_includes/docs-feedback.mdx'; +import DocsFeedback from '/\_includes/docs-feedback.mdx'; - diff --git a/docs/agents/query/tutorial-ecommerce.mdx b/docs/agents/query/tutorial-ecommerce.mdx index 8bef40a7f..79c2af122 100644 --- a/docs/agents/query/tutorial-ecommerce.mdx +++ b/docs/agents/query/tutorial-ecommerce.mdx @@ -51,7 +51,7 @@ The Query Agent: ## Prerequisites -To use the Weaviate Agents and Weaviate Embedding service, you need to have a **[Weaviate Cloud](https://weaviate.io/go/console?utm_source=docs&utm_content=agents)** account. +To use the Weaviate Agents and Weaviate Embedding service, you need to have a **[Weaviate Cloud](/go/console?utm_source=docs&utm_content=agents)** account. ## Step 1: Set up Weaviate diff --git a/docs/agents/query/usage.md b/docs/agents/query/usage.md index 4f1f8096f..db9b91aa5 100644 --- a/docs/agents/query/usage.md +++ b/docs/agents/query/usage.md @@ -31,7 +31,7 @@ This page describes how to use the Query Agent to answer natural language querie This Agent is available exclusively for use with a Weaviate Cloud instance. Refer to the [Weaviate Cloud documentation](/cloud/index.mdx) for more information on how to set up a Weaviate Cloud instance. -You can try this Weaviate Agent with a free Sandbox instance on [Weaviate Cloud](https://weaviate.io/go/console?utm_source=docs&utm_content=agents). +You can try this Weaviate Agent with a free Sandbox instance on [Weaviate Cloud](/go/console?utm_source=docs&utm_content=agents). ### Client library diff --git a/docs/agents/transformation/tutorial-enrich-dataset.mdx b/docs/agents/transformation/tutorial-enrich-dataset.mdx index 594ed49dc..935d3a0f9 100644 --- a/docs/agents/transformation/tutorial-enrich-dataset.mdx +++ b/docs/agents/transformation/tutorial-enrich-dataset.mdx @@ -62,7 +62,7 @@ The Transformation Agent: ## Prerequisites -To use the Weaviate Agents and Weaviate Embedding service, you need to have a **[Weaviate Cloud](https://weaviate.io/go/console?utm_source=docs&utm_content=agents)** account. +To use the Weaviate Agents and Weaviate Embedding service, you need to have a **[Weaviate Cloud](/go/console?utm_source=docs&utm_content=agents)** account. ## Step 1: Set up Weaviate @@ -337,7 +337,9 @@ import WeaviateAgentsExplorerTool from "/docs/agents/_includes/transformation_ag

    Now, you can open the{" "} - Explorer tool{" "} + + Explorer tool + {" "} to check the results of the transformation.

    diff --git a/docs/agents/transformation/usage.md b/docs/agents/transformation/usage.md index 73106435d..08b61f7c6 100644 --- a/docs/agents/transformation/usage.md +++ b/docs/agents/transformation/usage.md @@ -9,8 +9,7 @@ image: og/docs/agents.jpg import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; -import PyCode from '!!raw-loader!/docs/agents/_includes/transformation_agent.py'; - +import PyCode from '!!raw-loader!/docs/agents/\_includes/transformation_agent.py'; # Weaviate Transformation Agent: Usage @@ -50,7 +49,7 @@ This Agent is available exclusively for use with a Weaviate Cloud instance. Refer to the [Weaviate Cloud documentation](/cloud/index.mdx) for more information on how to set up a Weaviate Cloud instance. -You can try this Weaviate Agent with a free Sandbox instance on [Weaviate Cloud](https://weaviate.io/go/console?utm_source=docs&utm_content=agents). +You can try this Weaviate Agent with a free Sandbox instance on [Weaviate Cloud](/go/console?utm_source=docs&utm_content=agents). ### Client library @@ -233,6 +232,6 @@ This will be addressed in future versions of the Transformation Agent. The official changelog for Weaviate Agents can be [found here](https://weaviateagents.featurebase.app/changelog). If you have feedback, such as feature requests, bug reports or questions, please [submit them here](https://weaviateagents.featurebase.app/), where you will be able to see the status of your feedback and vote on others' feedback. ::: -import DocsFeedback from '/_includes/docs-feedback.mdx'; +import DocsFeedback from '/\_includes/docs-feedback.mdx'; diff --git a/docs/cloud/embeddings/administration.md b/docs/cloud/embeddings/administration.md index 4d684f404..cdf1d261a 100644 --- a/docs/cloud/embeddings/administration.md +++ b/docs/cloud/embeddings/administration.md @@ -7,7 +7,6 @@ image: og/wcd/user_guides.jpg import Link from '@docusaurus/Link'; - :::info Weaviate Embeddings is enabled by default at the organization level and is available to all Weaviate Cloud users. ::: @@ -22,7 +21,7 @@ import DisableWeaviateEmbeddings from '/docs/cloud/img/weaviate-cloud-disable-em
    1. - Open the Weaviate Cloud console. + Open the Weaviate Cloud console.
    2. Click on Weaviate Embeddings in the left sidebar (1). @@ -47,6 +46,7 @@ import DisableWeaviateEmbeddings from '/docs/cloud/img/weaviate-cloud-disable-em ## Pricing and billing + If you would like to learn about the pricing model, you can visit the Weaviate Embeddings [product page](https://weaviate.io/product/embeddings). The pricing works on a per-token basis. This means that you will only be billed for the tokens that are successfully consumed. In other words, only requests that result in valid responses from the API are considered. @@ -62,6 +62,6 @@ More info about billing in Weaviate Cloud can be found on [this page](/cloud/pla ## Support & feedback -import SupportAndTrouble from '/_includes/wcs/support-and-troubleshoot.mdx'; +import SupportAndTrouble from '/\_includes/wcs/support-and-troubleshoot.mdx'; diff --git a/docs/cloud/faq.mdx b/docs/cloud/faq.mdx index e34e25d11..9a3d50736 100644 --- a/docs/cloud/faq.mdx +++ b/docs/cloud/faq.mdx @@ -5,7 +5,7 @@ description: "Frequently asked questions and answers about Weaviate Cloud (WCD) image: og/wcd/faq.jpg --- -Frequently asked questions (FAQs) about [Weaviate Cloud (WCD)](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud). +Frequently asked questions (FAQs) about [Weaviate Cloud (WCD)](/go/console?utm_source=docs&utm_content=cloud). ## Features @@ -25,7 +25,7 @@ Using Weaviate Cloud gives you access to a 14-day free sandbox for testing. You
      Answer -Yes. Go to the [Weaviate Cloud login page](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) and click the "Log in" button. Then, click **"Forgot Password"** and enter your email. You’ll receive a reset email at that address. +Yes. Go to the [Weaviate Cloud login page](/go/console?utm_source=docs&utm_content=cloud) and click the "Log in" button. Then, click **"Forgot Password"** and enter your email. You’ll receive a reset email at that address.
      @@ -127,6 +127,6 @@ Weaviate updated it's Cloud offering on October 27th, 2025. Before that, **Share ## Support -import SupportAndTrouble from '/_includes/wcs/support-and-troubleshoot.mdx'; +import SupportAndTrouble from "/_includes/wcs/support-and-troubleshoot.mdx"; diff --git a/docs/cloud/manage-clusters/authentication.mdx b/docs/cloud/manage-clusters/authentication.mdx index bf1b24534..455619e16 100644 --- a/docs/cloud/manage-clusters/authentication.mdx +++ b/docs/cloud/manage-clusters/authentication.mdx @@ -56,7 +56,7 @@ If you don't have an existing API key, you'll need to create one. Follow these s To create an API key, follow these steps: -1. Open the [Weaviate Cloud console](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) and [select your cluster](/cloud/manage-clusters/status#select-a-cluster). +1. Open the [Weaviate Cloud console](/go/console?utm_source=docs&utm_content=cloud) and [select your cluster](/cloud/manage-clusters/status#select-a-cluster). 2. Navigate to the `API Keys` section, found in the `Cluster details` panel. 3. If you need a new API key, click the `New key` button. 4. In the `Create API Key` form, provide a descriptive name for your key. @@ -103,7 +103,7 @@ Rotating an API key allows you to generate a new key while invalidating the old To rotate an API key, follow these steps: -1. Open the [Weaviate Cloud console](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud). +1. Open the [Weaviate Cloud console](/go/console?utm_source=docs&utm_content=cloud). 2. [Select your cluster](/cloud/manage-clusters/status#select-a-cluster) and navigate to the `API Keys` section. 3. Locate the API key you want to rotate and click the `Rotate` button next to it. 4. A confirmation dialog will appear, explaining that the old key will be invalidated. Click `Rotate key` to proceed. @@ -148,7 +148,7 @@ Editing an API key allows you to modify its assigned roles. To edit an API key f To edit an API key's roles and permissions, follow these steps: -1. Open the [Weaviate Cloud console](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud). +1. Open the [Weaviate Cloud console](/go/console?utm_source=docs&utm_content=cloud). 2. [Select your cluster](/cloud/manage-clusters/status#select-a-cluster) and navigate to the `API Keys` section. 3. Locate the API key you want to edit and click the `Edit` button next to it. 4. In the `Edit API key` form, you can modify the key's description/name. @@ -194,7 +194,7 @@ To delete an API key, follow these steps: To delete an API key, follow these steps: -1. Open the [Weaviate Cloud console](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud). +1. Open the [Weaviate Cloud console](/go/console?utm_source=docs&utm_content=cloud). 2. [Select your cluster](/cloud/manage-clusters/status#select-a-cluster) and navigate to the `API Keys` section. 3. Locate the API key you want to delete and click the `Trash can` button next to it. 4. A confirmation dialog will appear. Enter the necessary text (usually the API key name or a confirmation phrase) to confirm the deletion. @@ -226,7 +226,9 @@ import Register from "/docs/cloud/img/weaviate-cloud-api-keys.png";
      1. Open the{" "} - Weaviate Cloud console{" "} + + Weaviate Cloud console + {" "} and{" "} {" "} @@ -295,7 +297,10 @@ import NewAPIKey from "/docs/cloud/img/weaviate-cloud-new-api-key.png";
        1. Open the{" "} - Weaviate Cloud console. + + Weaviate Cloud console + + .
        2. @@ -366,7 +371,10 @@ import DeleteAPIKey from "/docs/cloud/img/weaviate-cloud-delete-api-key.png";
          1. Open the{" "} - Weaviate Cloud console. + + Weaviate Cloud console + + .
          2. diff --git a/docs/cloud/manage-clusters/authorization.mdx b/docs/cloud/manage-clusters/authorization.mdx index 6e75127a4..ca940ae76 100644 --- a/docs/cloud/manage-clusters/authorization.mdx +++ b/docs/cloud/manage-clusters/authorization.mdx @@ -5,15 +5,15 @@ 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'; +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"; -import RestartTheCluster from '/_includes/wcs/restart-warning.mdx'; +import RestartTheCluster from "/_includes/wcs/restart-warning.mdx"; :::info @@ -58,13 +58,13 @@ Custom roles allow you to define specific permissions for different users or app To create a new role, follow these steps: -1. Open the [Weaviate Cloud console](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud). +1. Open the [Weaviate Cloud console](/go/console?utm_source=docs&utm_content=cloud). 2. [Select your cluster](/cloud/manage-clusters/status#select-a-cluster) and navigate to the `Roles` section. 3. Click on the `New role` button. 4. Enter a descriptive name for your role in the `Role name` field. 5. In the sections below, configure the permissions: - * Select which resources the permission applies to (for example, to which collections the role has access to) - * Choose the appropriate permissions (create, read, update, etc.) + - Select which resources the permission applies to (for example, to which collections the role has access to) + - Choose the appropriate permissions (create, read, update, etc.) 6. Click the `Create` button to save your new role. @@ -115,8 +115,8 @@ To edit a role, follow these steps: 1. From the roles management page, locate the role you want to edit. 2. Click the `Pencil` button next to the role you want to modify. 3. In the role editing interface, you can: - * Update collection permissions by checking or unchecking the appropriate boxes for Create, Read, Update, and Delete operations - * Add or remove additional constraints from the role's scope using the dropdown menus (e.g. which collections the permissions apply to) + - Update collection permissions by checking or unchecking the appropriate boxes for Create, Read, Update, and Delete operations + - Add or remove additional constraints from the role's scope using the dropdown menus (e.g. which collections the permissions apply to) 4. After making your changes, click the `Update` button to save the modifications. 5. Changes to role permissions take effect immediately for all API keys assigned to that role. @@ -185,6 +185,6 @@ You cannot delete the built-in admin and viewer roles, as these are system-defin ## Support -import SupportAndTrouble from '/_includes/wcs/support-and-troubleshoot.mdx'; +import SupportAndTrouble from "/_includes/wcs/support-and-troubleshoot.mdx"; diff --git a/docs/cloud/manage-clusters/connect.mdx b/docs/cloud/manage-clusters/connect.mdx index a84e808ab..abca4b9bb 100644 --- a/docs/cloud/manage-clusters/connect.mdx +++ b/docs/cloud/manage-clusters/connect.mdx @@ -8,7 +8,7 @@ image: og/wcd/user_guides.jpg import CompareURLs from "/docs/cloud/img/wcs-console-url-check.jpg"; -[Weaviate Cloud (WCD)](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) offers multiple options on how to connect to your cluster: +[Weaviate Cloud (WCD)](/go/console?utm_source=docs&utm_content=cloud) offers multiple options on how to connect to your cluster: - **[Connect with APIs](#connect-with-an-api-programmatically)**: - Use [client libraries](/weaviate/client-libraries) to connect to a Weaviate Cloud instance. @@ -74,7 +74,7 @@ If you don't have an existing API key, you'll need to create one. Follow these s Steps to create a new API key -1. Open the [Weaviate Cloud console](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) and [select your cluster](/cloud/manage-clusters/status#select-a-cluster). +1. Open the [Weaviate Cloud console](/go/console?utm_source=docs&utm_content=cloud) and [select your cluster](/cloud/manage-clusters/status#select-a-cluster). 2. Navigate to the `API Keys` section, found in the `Cluster details` panel. 3. If you need a new API key, click the `New key` button. 4. In the `Create API Key` form, provide a descriptive name for your key. @@ -120,7 +120,7 @@ The Weaviate Cloud console uses your email address and password for authenticati To connect to the console, follow these steps: -1. Open the [Weaviate Cloud login page](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) in a browser. +1. Open the [Weaviate Cloud login page](/go/console?utm_source=docs&utm_content=cloud) in a browser. 1. Enter your email address and click `Continue`. 1. Enter your password and click `Login`. @@ -161,7 +161,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](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud). +1. Go to the Weaviate Cloud [login page](/go/console?utm_source=docs&utm_content=cloud). 1. Click on click the login button. 1. Click `Forgot Password`. 1. Check your email account for a password reset email from Weaviate Cloud. diff --git a/docs/cloud/manage-clusters/create.mdx b/docs/cloud/manage-clusters/create.mdx index 60bec5b1f..23db8b335 100644 --- a/docs/cloud/manage-clusters/create.mdx +++ b/docs/cloud/manage-clusters/create.mdx @@ -5,7 +5,7 @@ description: "Step-by-step guide to create and configure new Sandbox or Shared C image: og/wcd/user_guides.jpg --- -[Weaviate Cloud (WCD)](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) provides two instance types. +[Weaviate Cloud (WCD)](/go/console?utm_source=docs&utm_content=cloud) provides two instance types. - **[Sandbox clusters](#sandbox-clusters)**: Sandbox clusters are small, free clusters designed for learning and experimentation. Sandbox clusters are not scalable and expire after 14 days. You will also have an option to extend their lifetime and convert them into a production ready Shared Cloud cluster. - **[Shared Cloud clusters](#shared-cloud-clusters)**: Shared Cloud clusters are robust, paid clusters designed for production use. @@ -112,8 +112,8 @@ To create a Shared Cloud cluster, follow these steps: The following advanced configuration settings are available: - * [`Enable auto schema generation`](/weaviate/config-refs/collections#auto-schema) - * `Allow all CORS origins` +- [`Enable auto schema generation`](/weaviate/config-refs/collections#auto-schema) +- `Allow all CORS origins` diff --git a/docs/cloud/manage-clusters/status.mdx b/docs/cloud/manage-clusters/status.mdx index 4c44618ee..88a498c65 100644 --- a/docs/cloud/manage-clusters/status.mdx +++ b/docs/cloud/manage-clusters/status.mdx @@ -5,20 +5,26 @@ description: "Monitor and check the operational status of your Weaviate Cloud cl image: og/wcd/user_guides.jpg --- -[Weaviate Cloud (WCD)](https://weaviate.io/go/console?utm_source=docs&utm_content=cloud) exposes two ways of checking the cluster status: +[Weaviate Cloud (WCD)](/go/console?utm_source=docs&utm_content=cloud) exposes two ways of checking the cluster status: - A **[web interface](#select-a-cluster)** in the Weaviate Cloud console. - An **[API endpoint](#api-endpoint)** that provides information about your Weaviate instance. ## Select a cluster -
            +