AV-91970: [Documentation] 8.0 Uptake on Capella #448

simon-dew · 2025-10-13T14:36:12Z

Docs issue: AV-91970

Docs preview: Use Vector Indexes for AI Applications and more
Credentials: Preview docs for internal review

Must be merged at the same time as:

Important

Avoid merging small edits directly into this PR. Where possible, try to use separate PRs to merge any further changes into the AV-91970-8-0-docs-uptake-capella branch.
Rebase and merge, or merge commit! Do not squash and merge

* [AV-105751] First draft of additional store params documentation on Capella * [AV-104690] Add HEAD.yml for previews

* [AV-104690] First draft of Capella version of synonym search updates, adapted from DOC-12754 * [AV-104690] Applicable comment from peer review on DOC-12754 * [AV-104690] Adjust set-type-identifier based on actual state of Capella UI * [AV-104690] Add HEAD.yml for previews * [AV-104690] Fix UI inconsistency * [AV-104690] Address peer review comments

* [AV-104691] First draft of synonym sources documentation for Capella * [AV-104690] Add HEAD.yml for previews * [AV-104691] Update to remove inconsistencies in procedure for add-synonym-source * [AV-104691] Change highlight style in synonym search example query to better show in Capella * [AV-104691] Fix typos * Update modules/search/pages/run-searches.adoc Co-authored-by: Daniel Nicholson <6208288+dgnicholson@users.noreply.github.com> * Update modules/search/pages/synonyms/add-synonym-source.adoc Co-authored-by: Daniel Nicholson <6208288+dgnicholson@users.noreply.github.com> * Update modules/search/pages/synonyms/create-synonym-collection-docs.adoc Co-authored-by: Daniel Nicholson <6208288+dgnicholson@users.noreply.github.com> --------- Co-authored-by: Daniel Nicholson <6208288+dgnicholson@users.noreply.github.com>

* Move pages to Indexes * Move diagrams to Indexes * Move examples to Indexes * Move images to Indexes * Move indexes concept doc back to docs-server * Remove unused image files * Update page aliases * Update links to GSI pages * Update coordinates of example files * Update GSI image coordinates * Update GSI diagram coordinates * Driveby fix unsupported icons * Minor changes to indexing overview and content order * Move covering indexes, group agg pushdown * Update links to covering indexes, grouping and agg pushdown * Driveby fix broken link

Minor corrections

…nerator (#280) * Update links to Query Settings REST API * Update includes of Query Settings REST API * Driveby fixes for CURL() function * Update links to Query Settings examples * Add table-style partial * Add table-style for CURL() reference

* Add Streaming Completed Requests * Try to make tabs sync with only partial success * Add system:completed_requests_history to sysinfo * Add links to Admin REST API * Update table formatting for sysinfo * Add links to gzip and jq

Fix grammar in the pre-filtering section

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

* DOC-13223: rebased to 7.6 * DOC-13223: changed to note * Update index-partitioning.adoc

…361)

…tive_requests (#363)

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

--------- Co-authored-by: Pallavi-Janardhan <pallavi.janardhan@couchbase.com>

* Removing single reference to memecached bukets * Removing Couchbase and Ephemeral at Richard's suggestion

… for L2 and Euclidean (#422) * Added note to Euclidean Distance to explain that Couchbase uses Euclidean Squared Distance instead behind the scenes. * Changed "FTS Vector Index" to "Search Vector Index" which is PM's current nomenclature. * Fixing a typo spotted by Nischal

* Use sequence diagrams for clearer readability * Minor wording tweaks

* Apply Vale suggestions for DDL and DML * Update Search Vector workflow diagram

* Rename Vector Indexes top-level topic * Rename Choose the Right Vector Index topic * An Search Vector → a Search Vector * Make vector index topic names consistent * Simplify xrefs in nav

* Explain how the appropriate index is selected * Explain all ANN_DISTANCE arguments in Hyperscale Vector index guide * Index Service not Query Service * ORDER BY not GROUP BY * Similarity is optional * Description is optional * Composite Vector index with leading scalar key * HVI and CVI are supported on Windows * Include persist_full_vector * Remove trailing spaces * Scan for typos * Capitalization of Hyperscale Vector and Composite Vector * Examples on this page * Remove feature branch preview config

* Update links to Capella * Hide service-level settings * Update replica examples * Remove page edition

* Add Vector Indexes to Developer Intro page * Add Migration Tutorial to server Developer Intro page * Fix Migration Tutorial: no empty headings in navigation

* [AV-102227] First draft of creating hyperscale and composite vector indexes based on Figma UI flow. Putting contents in partials to insert in Gary's content - might need to move folder location later. * [AV-102227] Change folder structure to keep partials with the rest of the content Gary's writing * [AV-102227] Adding in info about configuring filter fields and the different index configuration settings * [AV-102227] Update procedures after reviewing UI for limitations and extra options * [AV-102227] Update procedure based on significant UI changes * [AV-102227] Add instructions for creating FTS index with Vector Indexes flow * [AV-102227] Update FTS Vector Index -> Search Vector Index * [AV-102227] Updating procedures based on UI changes * [AV-102227] Update Search Vector index procedure and embedding dimension number * [AV-102227] Replace instances of an Search * [AV-102227] Insert partials into Gary's docs * Update modules/vector-search/pages/vector-search.adoc * Fix bad find and replace * [AV-102227] Comments from SME review * [AV-102227] Change training list value guidance * [AV-102227] Link fixes + peer review comments * Apply suggestions from code review Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com> * [AV-102227] HyperScale -> Hyperscale --------- Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>

--------- Co-authored-by: rakhi-prathap <rakhi-prathap@couchbase.com>

* Update Vector Search examples * Update Vector Index examples * Update Query examples * Update examples for Hyperscale Vector indexes * Update examples for Composite Vector indexes

* Update ALTER INDEX for Capella * Update ALTER VECTOR INDEX for Capella * Update common errors * Minor tweaks

…453)

osfameron · 2025-10-20T08:51:53Z

This PR won't "Rebase and Merge" cleanly.

That's probably for the best -- it's a lot of commits, including Merges back from Master.
If you're really wanting to Rebase this for the history, then Ideally you'd rebase along the way, and tidy up/squash commits as appropriate.

I guess that effort isn't worth it now, so we should do a Merge commit 👍

simon-dew · 2025-10-20T09:31:16Z

This PR won't "Rebase and Merge" cleanly

Yep, that's why I said "Rebase and merge, or merge commit!" I don't really mind which one, because they both preserve the commit history at the PR level.

The important thing is, do not squash and merge

* Update GRANT * Update REVOKE

simon-dew · 2025-10-21T15:25:55Z

Important

Do a merge commit! Do not squash and merge

… procedure

sarahlwelton and others added 30 commits July 10, 2025 15:53

[NO ISSUE] Vector Search Index -> FTS Vector Index

eb01ddf

[AV-105751] 8.0 on Capella - Document Search Index Store Object (#396)

e8b0da3

* [AV-105751] First draft of additional store params documentation on Capella * [AV-104690] Add HEAD.yml for previews

Merge branch 'capella' into AV-91970-8-0-docs-uptake-capella

76127df

[DOC-11988-7.6]: RBAC role change impact to eventing function

f506dad

Minor corrections

[DOC-12901]: erroneous vector search text (#312)

02ea005

Fix grammar in the pre-filtering section

[DOC-12921]: Feedback on Search Functions | Couchbase Docs (#324)

12431d6

[DOC-9249] Add HASHBYTES Function (#327)

b9a9f98

NO ISSUE: replace callout list for diagram (#330)

00e8f38

[DOC-11906] Add system:group_info & system:bucket_info keyspaces (#338)

74f18cb

[DOC-13215] Add COMPRESS() and UNCOMPRESS() Functions (#344)

6998915

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

[DOC-11766] Add EVALUATE Function (#346)

b157313

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

[DOC-10871] Add OBJECT_CONCAT2 Function (#333)

2528215

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

[DOC-10857] Add a note to ARRAY_REMOVE() (#334)

76d9463

[DOC-10792] Add OBJECT_TYPES/OBJECT_TYPES_NESTED functions (#331)

d51c13c

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

[DOC-10023] Add IS UNKNOWN Syntax (#343)

f1cb69a

DOC-13223 sizing guidelines, note on residentRatio (#347)

280cdd1

* DOC-13223: rebased to 7.6 * DOC-13223: changed to note * Update index-partitioning.adoc

[DOC-10001] Add new logging qualifiers to system:completed_requests (#…

2ed8792

…361)

[DOC 13257] Add new fields to system:completed_requests and system:ac…

41b92cd

…tive_requests (#363)

[DOC-12695] New SQL++ Statement - USING AI (#374)

b060f77

[DOC-12880] Auto Update Statistics (#360)

a4ade00

[DOC-12632] Auto Reprepare for PREPARE Statements (#387)

c67aa4c

--------- Co-authored-by: rakhi-prathap <rakhi.prathap@couchbase.com>

DOC-12757 Added information about OnDeploy (#391)

7cde974

--------- Co-authored-by: Pallavi-Janardhan <pallavi.janardhan@couchbase.com>

[DOC-12493] Add XATTR support to SQL++ statements (#388)

b577ae4

Removing single reference to memcached buckets (#367)

986e5c2

* Removing single reference to memecached bukets * Removing Couchbase and Ephemeral at Richard's suggestion

[DOC-10909] Add 'Errors' Logging Qualifier (#365)

d6f932c

ggray-cb and others added 5 commits October 13, 2025 14:26

NO ISSUE: Update workflow diagrams (#421)

cb54e59

* Use sequence diagrams for clearer readability * Minor wording tweaks

NO ISSUE: Style fixes (#432)

ad83d0e

* Apply Vale suggestions for DDL and DML * Update Search Vector workflow diagram

DOC-12464 Incorporate Vector Search in the Vector Index section (#443)

6ec601d

* Rename Vector Indexes top-level topic * Rename Choose the Right Vector Index topic * An Search Vector → a Search Vector * Make vector index topic names consistent * Simplify xrefs in nav

simon-dew mentioned this pull request Oct 13, 2025

AV-91970: [Documentation] 8.0 Uptake on Capella couchbaselabs/cb-swagger#183

Merged

simon-dew and others added 13 commits October 13, 2025 15:45

Merge branch 'capella' into AV-91970-8-0-docs-uptake-capella

2f1774b

NO ISSUE: Capella-specific GSI fixes (#449)

ca2f345

* Update links to Capella * Hide service-level settings * Update replica examples * Remove page edition

DOC-13634: Fix Developer Intro page (#451)

2c0570f

* Add Vector Indexes to Developer Intro page * Add Migration Tutorial to server Developer Intro page * Fix Migration Tutorial: no empty headings in navigation

GSI Vector Index-Hyperscale indexes doc changes (#450)

e039398

[DOC-9906] IS DISTINCT FROM Operator (#431)

695e2c7

Merge branch 'capella' into AV-91970-8-0-docs-uptake-capella

0da2ea3

[DOC-13536] USING AI - UI support and other improvements (#417)

1ade58e

[DOC-9978] New ARRAY_REPLACE_EQUIVALENT function (#427)

baf7202

[DOC-13581] AWR Improvements (#430)

9071112

--------- Co-authored-by: rakhi-prathap <rakhi-prathap@couchbase.com>

DOC-13644: [Capella] Vector-index sample bucket (#452)

05c9239

* Update Vector Search examples * Update Vector Index examples * Update Query examples * Update examples for Hyperscale Vector indexes * Update examples for Composite Vector indexes

DOC-13645: [Capella] ALTER INDEX move is disabled (#454)

36ed8f9

* Update ALTER INDEX for Capella * Update ALTER VECTOR INDEX for Capella * Update common errors * Minor tweaks

fixed a few issues I noticed when looking at the vector index intro. (#…

6a2ff07

…453)

simon-dew marked this pull request as ready for review October 17, 2025 22:09

simon-dew marked this pull request as draft October 20, 2025 10:41

DOC-13651: Incorrect role names in GRANT and REVOKE (#455)

0b4e115

* Update GRANT * Update REVOKE

sarahlwelton added 2 commits October 21, 2025 12:29

[NO ISSUE] Add anchor link for Learn More + fix formatting issue with…

2083c8e

… procedure

[NO ISSUE] Add anchor link for Learn More

2a552f3

dgnicholson marked this pull request as ready for review October 21, 2025 16:47

dgnicholson merged commit 9f06a7a into capella Oct 21, 2025
6 checks passed

dgnicholson deleted the AV-91970-8-0-docs-uptake-capella branch October 21, 2025 16:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

AV-91970: [Documentation] 8.0 Uptake on Capella #448

AV-91970: [Documentation] 8.0 Uptake on Capella #448

Uh oh!

simon-dew commented Oct 13, 2025 •

edited

Loading

Uh oh!

osfameron commented Oct 20, 2025 •

edited

Loading

Uh oh!

simon-dew commented Oct 20, 2025

Uh oh!

simon-dew commented Oct 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

AV-91970: [Documentation] 8.0 Uptake on Capella #448

AV-91970: [Documentation] 8.0 Uptake on Capella #448

Uh oh!

Conversation

simon-dew commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

osfameron commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simon-dew commented Oct 20, 2025

Uh oh!

simon-dew commented Oct 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

simon-dew commented Oct 13, 2025 •

edited

Loading

osfameron commented Oct 20, 2025 •

edited

Loading