[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475

RayOffiah · 2025-11-21T13:31:05Z

Clarified a few of the pain points around creating fields and mappings.
Added screenshots to hide options hidden within the UI.

Preview URL:
https://preview.docs-test.couchbase.com/docs-devex-DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs

You will need the Docs Team credentials on Confluence.

… Web Console | Couchbase Docs Clarified the section on adding a child mapping. Added a few pictures to make it clear what's going on. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>

sarahlwelton

I'm willing to entertain a good argument for the images, but I'm not down with the style issues. Please fix. :)

modules/vector-search/pages/create-vector-search-index-ui.adoc

sarahlwelton · 2025-11-21T14:01:48Z

modules/vector-search/pages/create-vector-search-index-ui.adoc

+.. Select the [.ui]*only index specified fields* checkbox.
+.. Unset the [.ui]*#default* field


Suggested change

.. Select the [.ui]*only index specified fields* checkbox.

.. Unset the [.ui]*#default* field

.. Under the collection name, select *only index specified fields*.

@RayOffiah Please don't just mark this as resolved and ignore it - why do you want to word it this way?

Can you at least please remove the [.ui] attribute?

Ah, my mistake; I think I miskeyed; I was going to accept the change, but now I think about, I think I prefer my version.

The reason DOC-13488 was filed in the first place was that the filer(?) thought that the original text was asking him to look a set of specified fields:

Regarding these instructions - it says "Only index specified fields". What fields? Specified where?

I would prefer to make it clear that he's looking for a checkbox.

But I can remove the [.ui] attributes.

modules/vector-search/pages/create-vector-search-index-ui.adoc

sarahlwelton · 2025-11-21T14:04:02Z

modules/vector-search/pages/create-vector-search-index-ui.adoc

+. Create a child field mapping on the new collection type mapping:
+
+.. Using the mouse over, hover over the [.ui]*Field* item, then click on the btn:[{plus}] button.
+.. Select menu:insert child field[] from the dropdown menu.


Suggested change

.. Select menu:insert child field[] from the dropdown menu.

We covered this in the previous step, this needs to be deleted.

Yeees, I'd rather keep this one, if you don't mind; the UI hides the function until you mouse over it, which confused the fella who submitted the initial Jira request.

We also don't refer to dropdowns like this: https://docs.couchbase.com/styleguide/dropdowns.html

In general, I would say this is a menu, which is why I said to use the menu:[] macro to render it as + > insert child field: https://docs.couchbase.com/styleguide/menus.html

But you're navigating in the menu? We're telling them to do the same thing twice if you leave this as is. Try and rebuild the site with this suggestion in place and you'll see what I mean.

They don't need to click insert child field twice, and this is what it's telling them to do right now.

Ah, yes; got it now.

modules/vector-search/pages/create-vector-search-index-ui.adoc

modules/vector-search/images/only-index-specified-field-checkbox.png

sarahlwelton · 2025-11-21T14:05:08Z

modules/vector-search/images/insert-child-field.png

Please remove this.

I think this one is helpful, so I think I'd rather keep it, if that's okay.

As I said, open to the arguments for keeping them - I'm okay with 1 screenshot for the tricky "this is where the menu is", but 3 felt like overkill :)

modules/vector-search/images/child-mapping-parameters.png

rao-shwe

LGTM! 👍

sarahlwelton

One additional thing.

modules/vector-search/pages/create-vector-search-index-ui.adoc

Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>

sarahlwelton

These changes still need to be made, please.

sarahlwelton · 2025-11-21T15:50:22Z

modules/vector-search/pages/create-vector-search-index-ui.adoc

+.. Select the [.ui]*only index specified fields* checkbox.
+.. Unset the [.ui]*#default* field


@RayOffiah Please don't just mark this as resolved and ignore it - why do you want to word it this way?

sarahlwelton · 2025-11-21T15:51:13Z

modules/vector-search/pages/create-vector-search-index-ui.adoc

+. Create a child field mapping on the new collection type mapping:
+
+.. Using the mouse over, hover over the [.ui]*Field* item, then click on the btn:[{plus}] button.
+.. Select menu:insert child field[] from the dropdown menu.


We covered this in the previous step, this needs to be deleted.

sarahlwelton · 2025-11-21T15:59:14Z

modules/vector-search/pages/create-vector-search-index-ui.adoc

+. Create a child field mapping on the new collection type mapping:
+
+.. Using the mouse over, hover over the [.ui]*Field* item, then click on the btn:[{plus}] button.
+.. Select menu:insert child field[] from the dropdown menu.


We also don't refer to dropdowns like this: https://docs.couchbase.com/styleguide/dropdowns.html

In general, I would say this is a menu, which is why I said to use the menu:[] macro to render it as + > insert child field: https://docs.couchbase.com/styleguide/menus.html

… Web Console | Couchbase Docs Changes following reviews.

sarahlwelton

Style guidance does want us to not refer to "checkbox" specifically, and I think we could have avoided it on Line 61, specifically.

We can always revisit this in a future discussion about style.

But, just one more thing to fix in this PR, just to make sure we're not repeating ourselves. I'll be happy to remove my Request Changes once we get this sorted.

Thanks for your patience, @RayOffiah :)

sarahlwelton · 2025-11-21T16:58:46Z

modules/vector-search/images/insert-child-field.png

As I said, open to the arguments for keeping them - I'm okay with 1 screenshot for the tricky "this is where the menu is", but 3 felt like overkill :)

sarahlwelton · 2025-11-21T16:59:30Z

modules/vector-search/pages/create-vector-search-index-ui.adoc

 .. In the *Collection* list, select the collection that contains the documents you want to include in your index. 
-.. Select *Only index specified fields*. 
+.. Select the *only index specified fields* checkbox.
+.. Unset the *#default* field


Sorry, if we're telling them to "clear the default type mapping" further down, I don't think we need this step. It's the same thing, right?

[DOC-13488]: Feedback on Create a Vector Search Index with the Server…

6b56e2c

… Web Console | Couchbase Docs Clarified the section on adding a child mapping. Added a few pictures to make it clear what's going on. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>

RayOffiah requested a review from a team November 21, 2025 13:31

RayOffiah self-assigned this Nov 21, 2025

RayOffiah added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request 8.0 Couchbase Server 8.0 labels Nov 21, 2025

sarahlwelton requested changes Nov 21, 2025

View reviewed changes

rao-shwe approved these changes Nov 21, 2025

View reviewed changes

sarahlwelton requested changes Nov 21, 2025

View reviewed changes

modules/vector-search/pages/create-vector-search-index-ui.adoc Show resolved Hide resolved

RayOffiah and others added 3 commits November 21, 2025 15:43

Update modules/vector-search/pages/create-vector-search-index-ui.adoc

afe5b83

Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>

Update modules/vector-search/pages/create-vector-search-index-ui.adoc

f2e0c7f

Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>

Update modules/vector-search/pages/create-vector-search-index-ui.adoc

89e5b52

Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>

sarahlwelton requested changes Nov 21, 2025

View reviewed changes

RayOffiah force-pushed the DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs branch from 80b59fc to acf2386 Compare November 21, 2025 16:02

RayOffiah requested review from rao-shwe and sarahlwelton November 21, 2025 16:03

RayOffiah force-pushed the DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs branch from acf2386 to 8bbeb46 Compare November 21, 2025 16:09

[DOC-13488]: Feedback on Create a Vector Search Index with the Server…

0705d26

… Web Console | Couchbase Docs Changes following reviews.

RayOffiah force-pushed the DOC-13488-Feedback-on-Create-a-Vector-Search-Index-with-the-Server-Web-Console--Couchbase-Docs branch from 430d86e to 0705d26 Compare November 21, 2025 16:38

sarahlwelton reviewed Nov 21, 2025

View reviewed changes

		.. Select the [.ui]only index specified fields checkbox.
		.. Unset the [.ui]#default field

	.. Select the [.ui]only index specified fields checkbox.
	.. Unset the [.ui]#default field
	.. Under the collection name, select only index specified fields.

[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475

Are you sure you want to change the base?

[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475

Uh oh!

Conversation

RayOffiah commented Nov 21, 2025

Uh oh!

sarahlwelton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sarahlwelton Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rao-shwe left a comment

Choose a reason for hiding this comment

Uh oh!

sarahlwelton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sarahlwelton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarahlwelton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sarahlwelton Nov 21, 2025 •

edited

Loading