Skip to content

DOC-14331: Document Vector Index UI in Server - #4144

Open
simon-dew wants to merge 5 commits into
release/8.1from
DOC-14331-vector-idx-ui
Open

DOC-14331: Document Vector Index UI in Server#4144
simon-dew wants to merge 5 commits into
release/8.1from
DOC-14331-vector-idx-ui

Conversation

@simon-dew

@simon-dew simon-dew commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Jira issue: DOC-14331

Preview documentation: Couchbase Web Console › Vector Indexes

You will need the Docs Team credentials on Confluence.

Using the Couchbase Web Console to create Hyperscale Vector Indexes and Composite Vector Indexes is covered in detail by the following pull request:

Note

  • I have not updated the style and tone throughout the rest of this page, although it is out of date.
  • This PR adds new screenshots. I have not updated any of the existing screenshots, although all of these now need updating because none of them have the Vectors tab.
  • @simon-dew Remove the branch preview config before merge

@simon-dew
simon-dew marked this pull request as ready for review August 6, 2026 21:04
@simon-dew simon-dew self-assigned this Aug 6, 2026
@simon-dew

simon-dew commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

@supritha-kumar Please let me know what to do about style, tone, and screenshots on this page. If you want me to update all the other screenshots to add the Vectors tab, or take this opportunity to remove all the screenshots, I'm happy to do either. Likewise if you want me to address style and tone issues on this page, I can also do that as part of this PR. Alternatively, if you to address these issues in a separate PR, that's fine with me.

@ggray-cb ggray-cb left a comment

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.

Have a few wording suggestions for style adherence.

Comment thread modules/manage/pages/manage-ui/manage-ui.adoc
Comment thread modules/manage/pages/manage-ui/manage-ui.adoc
[#console-vectors-tab]
image::manage-ui/vectorTab.png["Vectors tab with mouse pointer.",100,align=left]

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants