Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 49 additions & 1 deletion modules/manage/pages/manage-ui/manage-ui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
:description: The features of Couchbase Server can be managed by means of Couchbase Web Console.
// :page-aliases: c-sdk:ROOT:webui-cli-access.adoc,dotnet-sdk:ROOT:webui-cli-access.adoc,go-sdk:ROOT:webui-cli-access.adoc,java-sdk:ROOT:webui-cli-access.adoc,nodejs-sdk:ROOT:webui-cli-access.adoc,php-sdk:ROOT:webui-cli-access.adoc,python-sdk:ROOT:webui-cli-access.adoc,

// TEMP
:totoro: the next major release of Couchbase Server

[abstract]
{description}

Expand Down Expand Up @@ -498,14 +501,59 @@ image::manage-ui/indexScreenWithIndexes.png[,700,align=left]
Note that initially, the *status* column provides ongoing figures for *mutations remaining*: this indicates that the indexes for the bucket are still being prepared.
When the indexes have been fully prepared, the *mutations remaining* notifications are no longer displayed:

image:manage-ui/indexesScreenFullyPrepared.png[,700,align=left]
image::manage-ui/indexesScreenFullyPrepared.png[,700,align=left]

[#indexes-define-and-manage]
=== Indexes: Define and Manage

For a detailed explanation of indexes, see xref:indexes:indexing-overview.adoc[].
Information on how to manage indexes is given in xref:manage:manage-indexes/manage-indexes.adoc[Manage Indexes].

[#console-vectors]
== Vector Indexes

[.labels]
[.status]#{totoro}#

To access vector indexes, left-click the *Vectors* tab in the left-hand navigation bar:
Comment thread
simon-dew marked this conversation as resolved.

[#console-vectors-tab]
image::manage-ui/vectorTab.png["Vectors tab with mouse pointer.",100,align=left]
Comment thread
simon-dew marked this conversation as resolved.

This brings up the *Vector Indexes* screen:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're not suppose to have these lead-in sentences that just introduce a screenshot. I'd move the sentence after the screenhot up:

Suggested change
This brings up the *Vector Indexes* screen:
The *Vector Indexes* page is initially blank because you have not yet added vector indexes.


[#console-vectors-screen]
image::manage-ui/vectorScreen.png["Vector Indexes screen with no indexes",700,align=left]

The screen is initially blank, since no vector indexes have yet been added.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The screen is initially blank, since no vector indexes have yet been added.

Vector indexes are not included in the sample data provided with Couchbase Server.

To create a vector index, click btn:[Add Vector Index].

* For more information about creating a Hyperscale Vector Index, see xref:vector-index:hyperscale-vector-index.adoc[].

* For more information about creating a Composite Vector Index, see xref:vector-index:composite-vector-index.adoc[].

* For more information about creating a Search Vector Index, see xref:vector-search:create-vector-search-index-ui.adoc[].

[#vectors-learn-and-manage]
=== Vector Indexes: Learn and Manage

If you have created any vector indexes, they're listed in the *Vector Indexes* screen:

image::manage-ui/vectorScreenWithIndexes.png["Vector Indexes screen with 3 indexes",700,align=left]

For each vector index in the Vector Indexes screen, the following options are available:

* Click the vector index name to edit the vector index.
(For Hyperscale Vector Indexes and Composite Vector Indexes, you can only edit the number of index replicas.)

* Click btn:[Search] to run a query or search using that vector index.

* Click btn:[⋮] to display a menu which enables you to copy the vector index definition, download the vector index definition, or delete the vector index.

For a detailed explanation of vector indexes, see xref:vector-index:vectors-and-indexes-overview.adoc[].

[#console-search]
== Search

Expand Down
27 changes: 27 additions & 0 deletions preview/DOC-14331-vector-idx-ui.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
sources:
docs-devex:
branches: DOC-14050-sparse-vector-concept

# docs-analytics:
# branches: release/8.0

couchbase-cli:
url: https://github.com/couchbaselabs/couchbase-cli-doc
branches: master
startPaths: docs/

# backup:
# branches: master
# startPaths: docs/

cb-swagger:
url: https://github.com/couchbaselabs/cb-swagger
branches: release/8.1
start_path: docs

# Minimal SDK build
# docs-sdk-common:
# branches: [release/8.0]
# docs-sdk-java:
# branches: [3.11]