Skip to content

Commit 1d3ce04

Browse files
authored
[DOC-12934] Add an admonition calling out lack of Windows support (#313)
1 parent 156143c commit 1d3ce04

10 files changed

+23
-1
lines changed

modules/vector-search/pages/create-vector-search-index-rest-api.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ You must create a Search index before you can xref:run-vector-search-rest-api.ad
1212
TIP: Vector Search indexes can include all the same features and settings as a Search index.
1313
For more information about Search indexes, see the xref:search:search.adoc[Search documentation].
1414

15+
include::partial$vector-search-no-windows.adoc[]
16+
1517
== Prerequisites
1618

1719
* You have the Search Service enabled on a node in your database.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ You must create a Vector Search index before you can xref:run-vector-search-ui.a
1313
TIP: Vector Search indexes can include all the same features and settings as a Search index.
1414
For more information about Search indexes, see the xref:search:search.adoc[Search documentation].
1515

16+
include::partial$vector-search-no-windows.adoc[]
17+
1618
== Prerequisites
1719

1820
* You have the Search Service enabled on a node in your database.

modules/vector-search/pages/fine-tune-vector-search.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[abstract]
88
{description}
99

10-
10+
include::partial$vector-search-no-windows.adoc[]
1111

1212
The Search Service automatically tunes your Vector Search indexes to achieve a balance between:
1313

modules/vector-search/pages/pre-filtering-vector-search.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The Search Service supports pre-filtering on Vector Search queries.
1212
Pre-filtering allows you to execute vector searches over a subset of the vector index,
1313
via the means of a filter request that qualifies the subset.
1414

15+
include::partial$vector-search-no-windows.adoc[]
1516

1617
== Prerequisites
1718

modules/vector-search/pages/run-vector-search-rest-api.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
For more information about how the Search Service scores documents in search results, see xref:run-searches.adoc#scoring[Scoring for Search Queries].
1111

12+
include::partial$vector-search-no-windows.adoc[]
13+
1214
== Prerequisites
1315

1416
* You have the Search Service enabled on a node in your database.

modules/vector-search/pages/run-vector-search-sdk.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
[abstract]
1010
{description}
1111

12+
include::partial$vector-search-no-windows.adoc[]
13+
1214
For more information about how the Search Service scores documents in search results, see xref:search:run-searches.adoc#scoring[Scoring for Search Queries].
1315

1416
[TIP]

modules/vector-search/pages/run-vector-search-ui.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
For more information about how the Search Service scores documents in search results, see xref:run-searches.adoc#scoring[Scoring for Search Queries].
1111

12+
include::partial$vector-search-no-windows.adoc[]
13+
1214
== Prerequisites
1315

1416
* You have the Search Service enabled on a node in your database.

modules/vector-search/pages/vector-search-index-architecture.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[abstract]
77
{description}
88

9+
include::partial$vector-search-no-windows.adoc[]
10+
911
A Vector Search index still relies on <<sync,>> and uses <<segments,>> to manage merging and persisting data to disk in your cluster.
1012
All changes from Database Change Protocol (DCP) and the Data Service are introduced to a Search index in batches, which are further managed by segments.
1113

modules/vector-search/pages/vector-search.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
[abstract]
88
{description}
99

10+
include::partial$vector-search-no-windows.adoc[]
11+
1012
== About Vector Search
1113

1214
Vector Search builds on Couchbase {page-product-name}'s xref:search:search.adoc[Search Service] to provide vector index support.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[IMPORTANT]
2+
--
3+
You cannot use Vector Search on Windows platforms.
4+
You can use Vector Search on Linux from Couchbase {page-product-name} version 7.6.0 and MacOS from version 7.6.2.
5+
6+
You can still use other features of the xref:search:search.adoc[Search Service].
7+
--

0 commit comments

Comments
 (0)