Skip to content

Conversation

@sarahlwelton
Copy link
Contributor

This PR covers all of the changes that needed to be made to UI procedures based on the v3 release of the FTS UI.

Vector Search topics were also updated.

Preview site: https://preview.docs-test.couchbase.com/sarah-AV-84497/cloud/search/create-search-indexes.html

…ger worked/made sense. Went to just headings/sections.

Created a new topic for default-date-time-parsers - still need to fill in what the defaults are.

Rewrote set-advanced-settings to focus on global index settings and link to other appropriate references.
… I need the descriptions in future

Deleting create-child-field, create-child-mapping, create-quick-index, create-type-mapping, create-xattrs-mapping, quick-index-field-options, quick-index-supported-languages

Modifying nav.adoc for new file changes.

Starting rewriting on create-custom-analyzer, create-custom-character-filter, create-custom-date-time-parser, create-search-index-ui (the one create topic to rule them all (mostly)), create-search-indexes, set-advanced-settings, set-type-identifier

Created new type-mapping-options file

Continued rewrite of customize-index

Reorganized default-analyzers-reference
…and index-aliases into . files (unsure if they'll be needed or if they should be removed)

Fixed broken link in searchfun.adoc

Finished rewriting all topics for creating custom analyzers

Changing wording to Global Index Settings, capitalizing Add To Index, adding anchor link to create-search-index-ui.adoc

Expanding upon explanation of Quick and Advanced in create-search-indexes.adoc, removing link to index-aliases

Adding better link to explanation of Quick and Advanced mode, changing heading to just describe analyzers in general, fixing tokenizers instead of token filters typo, expanding upon when you can create a custom wordlist in customize-index.adoc

Fixing link in default-analyzers-reference

Rewriting procedure for index creation in geo-search-ui

Commenting out Search alias mentions and rewriting procedure in import-search-index

Commenting out index aliases in run-searches

Fixing broken link in search-index-params.adoc

Rewriting procedure in search-query-auto-complete-ui

Adding comments to follow up on and fixing some broken links in search-request-params. Need to investigate term vectors setting.

Correcting title and removing broken links in set-type-identifier

Adding anchor link, still need to resolve a lot of questions around XATTRs mapping behaviour in type-mapping-options

Updating nav.adoc to reorganize IA and remove broken links

Fixing links and removing unnecessary text in create-vector-search-index-ui

Fixing link in run-vector-search-sdk

Fixing link in vector-search
…earch index alias topics

Restored links to search index alias content in all topics

Changed database to operational cluster throughout

Rewrote the start of procedures for analyzers and analyzer components to make it clearer that you can start with an existing search index

Changed negative contractions in default-character-filters-reference
Recreating create-type-mapping

Tweaking nav.adoc
@sarahlwelton sarahlwelton self-assigned this Dec 6, 2024
Copy link
Contributor

@dgnicholson dgnicholson left a comment

Choose a reason for hiding this comment

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

Excellent work, especially given the breadth of the changes!

For future reference, consider splitting up PRs of this size to make the review process a bit easier. Perhaps you could separate minor text changes from new text changes?

I’ve added a few minor items and questions, but nothing is blocking. Thank you for your work on keeping the Search docs clear and helpful. 🚀

// In Advanced mode, this was not available as a single option.
// You needed to turn on both *Include Term Vectors* and *Store*.

|[[#term-vectors]]Support phrase matching
Copy link
Contributor

Choose a reason for hiding this comment

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

This anchor tag is rendering on the page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, good shout. Mixed up my syntax, should be good now.

Comment on lines +13 to +17
* <<collection,>>
* <<object,>>
* <<xattrs,>>
* <<field,>>
Copy link
Contributor

Choose a reason for hiding this comment

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

I didn't know you could leave out the link text. Neat. 📸

Comment on lines 11 to 13
NOTE: You must use Advanced Mode to add a custom analyzer to your Search index.
For more information, see xref:create-search-index-ui.adoc[].
For more information, see xref:create-search-indexes.adoc#advanced-mode[Advanced Mode Editing].

For more information, see xref:customize-index.adoc#analyzers[Search Index Features].
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a better way to have both these "For more information..." links? Maybe put line 13 above the admonition?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's try this.

====
For indexes created with Couchbase Server version 7.6 and later, index names must be unique inside a bucket and scope.
You cannot have 2 indexes with the same name inside the same bucket and scope on a {page-product-name} cluster running version 7.6.
You cannot have 2 indexes with the same name inside the same bucket and scope on a {page-product-name} operational cluster running version 7.6.
Copy link
Contributor

Choose a reason for hiding this comment

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

Little out of scope, but is this just 7.6 or 7.6 and later?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Easy enough to fix while we're in here.

Copy link
Contributor

@Rebecca-Martinez007 Rebecca-Martinez007 left a comment

Choose a reason for hiding this comment

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

Overall, LGTM! Considering the size of this PR, I thought a second set of eyes alongside Daniel's review would be beneficial.

I left a comment discussing the page where the new UI is compared to the old UI - opening up a discussion, but definitely not a showstopper, so I'll approve!


The Search Service adds all document fields inside the object to your Search index.

In the previous version of the Search Service UI, this option was not available.
Copy link
Contributor

Choose a reason for hiding this comment

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

In reading through a couple of these in this page, I'm wondering if offering the users a reminder of what the page used to be would be beneficial or confusing. Would they remember what the UI used to look like? Is this going to maintain well with time?

This is just a thought I had - open to hearing thoughts/arguments for it!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Too much maintenance headache. The plan is to eventually remove even these notes - it was just a request from eng that I wasn't crazy about including in the first place.

@sarahlwelton sarahlwelton merged commit 480dfba into capella Jan 20, 2025
@sarahlwelton sarahlwelton deleted the AV-84497-v3-search-ui branch January 20, 2025 16:06
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.

4 participants