docs(cloud): remove dead imports, add the missing default-index row, fix typos - #504
Open
g-despot wants to merge 1 commit into
Open
docs(cloud): remove dead imports, add the missing default-index row, fix typos#504g-despot wants to merge 1 commit into
g-despot wants to merge 1 commit into
Conversation
…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.
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Secrets |  0  0  0  0 |
View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
Cleans up Cloud documentation and clarifies default vector-index behavior.
Changes:
- Removes 17 unused imports.
- Documents profile-based
DEFAULT_VECTOR_INDEXselection. - Corrects wording, numbering, and response formatting.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
docs/cloud/tools/collections-tool.mdx |
Fixes two pronoun typos. |
docs/cloud/quickstart.mdx |
Removes imports and updates the response example. |
docs/cloud/platform/users-and-organizations.mdx |
Improves warning punctuation. |
docs/cloud/platform/multi-factor-auth.mdx |
Removes imports and fixes duplicated text. |
docs/cloud/platform/create-account.mdx |
Removes an import and fixes step numbering. |
docs/cloud/manage-clusters/default-settings.mdx |
Documents the profile-dependent vector-index default. |
docs/cloud/manage-clusters/connect.mdx |
Removes an import and corrects troubleshooting text. |
docs/cloud/manage-clusters/authorization.mdx |
Removes unused role-management imports. |
docs/cloud/manage-clusters/authentication.mdx |
Removes unused API-key and warning imports. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+261
to
+262
| } | ||
| { |
| **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. |
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Low tier, 7 of 7. 3 findings, 9 files.
Seventeen dead imports left from a migration that replaced screenshots with iframes. One was a downtime warning, and it is the interesting one: it was flagged to me as a suppressed warning users never see, and I passed that on. The lane checked the history and reversed it. The include was only ever rendered in the now-deleted non-RBAC section, and today's clusters set
AUTHENTICATION_DB_USERS_ENABLED, so key operations are runtime. Rendering it would have told readers that routine key rotation costs downtime, discouraging a security-hygiene action that is actually instant. The import is removed and the now-unreferenced include deleted.The database settings table omitted
DEFAULT_VECTOR_INDEXalthough 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 and the precedence rule.Also an invalid JSON response block and "Select you" for "your", twice.
Verified: build exit 0; all 17 removed imports confirmed to have zero usages in the baseline.