-
Notifications
You must be signed in to change notification settings - Fork 19
[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC-13488]: Feedback on Create a Vector Search Index with the Server Web Console | Couchbase Docs #475
Changes from 1 commit
6b56e2c
afe5b83
f2e0c7f
89e5b52
0705d26
7472756
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please remove this.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this one is helpful, so I think I'd rather keep it, if that's okay.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 :)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agreed. The other two didn't really add anything. |
RayOffiah marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |||||||
| :page-ui-name: {ui-name} | ||||||||
| :page-product-name: {product-name} | ||||||||
| :page-toclevels: 2 | ||||||||
| :description: You can create a Search Vector Index with the Couchbase {page-ui-name}. | ||||||||
| :description: Using a sample dataset to create a vector search index with the Couchbase {page-ui-name}. | ||||||||
RayOffiah marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||
|
|
||||||||
| [abstract] | ||||||||
| {description} | ||||||||
|
|
@@ -45,7 +45,7 @@ To create a Search Vector Index with the Couchbase {page-ui-name}: | |||||||
| + | ||||||||
| [NOTE] | ||||||||
| ==== | ||||||||
| Your index name must start with an alphabetic character (a-z or A-Z). It can only contain alphanumeric characters (a-z, A-Z, or 0-9), hyphens (-), or underscores (_). | ||||||||
| Your index name must start with an alphabetic character (a-z or A-Z). It can only contain alphanumeric characters (a-z, A-Z, or 0–9), hyphens (-), or underscores (_). | ||||||||
|
|
||||||||
| For Couchbase Server version 7.6 and later, your index name must be unique inside your selected bucket and scope. | ||||||||
| You cannot have 2 indexes with the same name inside the same bucket and scope. | ||||||||
|
|
@@ -58,13 +58,23 @@ You cannot have 2 indexes with the same name inside the same bucket and scope. | |||||||
| . Expand *Mappings* and create a new type mapping on a collection: | ||||||||
| .. Click btn:[Add Type Mapping]. | ||||||||
| .. 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 [.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*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@RayOffiah Please don't just mark this as resolved and ignore it - why do you want to word it this way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you at least please remove the [.ui] attribute?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
RayOffiah marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
RayOffiah marked this conversation as resolved.
Show resolved
Hide resolved
RayOffiah marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| .. Select menu:insert child field[] from the dropdown menu. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We covered this in the previous step, this needs to be deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, yes; got it now.
RayOffiah marked this conversation as resolved.
Show resolved
Hide resolved
RayOffiah marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| sources: | ||
| docs-server: | ||
| branches: [release/8.0] | ||
| cb-swagger: | ||
| branches: [release/8.0] | ||
| override: | ||
| startPage: server:introduction:intro.adoc |
Uh oh!
There was an error while loading. Please reload this page.