[AV-41998] Couchbase Glossary by sarahlwelton · Pull Request #885 · couchbase/docs-site

sarahlwelton · 2026-03-30T18:31:06Z

Creating glossary.adoc.

Exact location in nav TBD, pending review from entire team + stakeholders.

simon-dew

Added some suggestions and updates for Query. Can iterate with links to further explanations of Query terms

simon-dew · 2026-03-31T09:51:59Z

@@ -0,0 +1,479 @@
+= Couchbase Glossary


AsciiDoc apparently has a markup that's designed for glossaries — see Glossary. But it's not clear to me what the benefit of the [glossary] style is or why we would want to apply it. It may be useful if we want to apply specific styling just to the glossary. If that's not necessary we probably don't need it.

I'm not sure if we have anything that takes advantage of that markup, or if the "book" features are even heavily used in our docs set now? Might be worth a look, might be worth considering, I'm just not sure we're set up for it right now.

simon-dew · 2026-03-31T10:03:01Z

+ACID stands for Atomicity, Consistency, Isolation, and Durability.
+Couchbase supports ACID transactions across multiple documents.
+
+*Adaptive Index*:: An index type that adjusts its structure based on query patterns and data distribution, providing flexibility for evolving workloads.


💡 idea! Can we have anchors for each glossary term so that we can link to them from other parts of the documentation?

Yes, agree we should do this!
(Probably easiest to do as a single post-process, once the list is agreed, to give the LLM less to worry about)

Yup would love to do this.

Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>

sarahlwelton · 2026-03-31T14:30:49Z

Added some suggestions and updates for Query. Can iterate with links to further explanations of Query terms

I've committed your suggestions for now - please make sure to come back and add links to further explanations!

…p from entries

rakhi-prathap

@sarahlwelton - Looking at the A-Z Word List, I'm wondering if we could try a similar layout for the glossary too. It seems more readable and easy to scan. Just a thought for later!

sarahlwelton · 2026-04-01T13:29:31Z

@sarahlwelton - Looking at the A-Z Word List, I'm wondering if we could try a similar layout for the glossary too. It seems more readable and easy to scan. Just a thought for later!

Good idea! Definitely something we can see about getting set up, if we want to move away from the classic description list format - this was just AI's first attempt at formatting :)

@simon-dew , if we do that, I'm not sure that we'd be able to take advantage of the [glossary] formatting/styling support from Antora/AsciiDoc, so I think we'll need to decide what we like more and what we want to do on the presentation side.

Rebecca-Martinez007

Adding in some suggestions. I'll need to re-review to include links to more of the definitions.

Rebecca-Martinez007 · 2026-04-24T21:29:01Z

+Collection:: A logical container within a scope that stores related JSON documents.
+Collections provide data organization similar to tables in relational databases and serve as the unit of authorization and resource allocation.
+
+Columnar Collection:: A collection in Capella Analytics optimized for columnar storage, suitable for analytical workloads with efficient storage and query processing.


Just something I noticed, do we still say "Columnar Collection"? CC: @zeba-shireen

Rebecca-Martinez007 · 2026-04-24T21:31:19Z

+
+== C
+
+Capella:: Couchbase's fully managed database-as-a-service (DBaaS) platform that runs on cloud infrastructure (AWS, Azure, GCP), providing operational databases, analytics, App Services, and AI capabilities without requiring server management.


Suggested change

Capella:: Couchbase's fully managed database-as-a-service (DBaaS) platform that runs on cloud infrastructure (AWS, Azure, GCP), providing operational databases, analytics, App Services, and AI capabilities without requiring server management.

Capella:: Couchbase's fully managed database-as-a-service (DBaaS) platform that runs on cloud infrastructure (AWS, Azure, GCP), providing operational clusters, analytics, App Services, and AI capabilities without requiring server management.

I don't think I quite want to make this change when we're trying to introduce people to the concepts of Couchbase. Let me think on it a bit more.

Rebecca-Martinez007 · 2026-04-24T21:43:20Z

+
+Primary Index:: An index covering all documents in a collection using the document key, enabling queries without secondary indexes and supporting full collection scans.
+
+Private Endpoint:: A network interface for accessing Capella services through private network connections rather than the public Internet, enhancing security and performance.


Suggested change

Private Endpoint:: A network interface for accessing Capella services through private network connections rather than the public Internet, enhancing security and performance.

Private Endpoint:: A network interface for accessing Capella services through private network connections rather than the public Internet, enhancing security and performance.

Private connectivity is provided through each cloud provider’s native private endpoint technology, including AWS PrivateLink on Amazon Web Services, Azure Private Link on Microsoft Azure, and Private Service Connect on Google Cloud Platform.

Can we say "Cloud Service Provider" instead of "cloud provider"?

Rebecca-Martinez007 · 2026-04-24T22:15:56Z

+
+== Q
+
+Query:: The Couchbase service that executes SQL++ queries for data retrieval and manipulation, providing powerful querying capabilities across JSON documents.


Suggested change

Query:: The Couchbase service that executes SQL++ queries for data retrieval and manipulation, providing powerful querying capabilities across JSON documents.

Query:: A specific SQL++ statement used to retrieve, filter, aggregate, or manipulate data stored within JSON documents.

Can we use the {sqlpp} attribute please?

Rebecca-Martinez007 · 2026-04-24T22:16:07Z

+
+Query Plan:: The execution strategy generated by the Query Service for a SQL++ query, showing how the query is executed and which indexes are used.
+
+Query Service:: See Query.


Suggested change

Query Service:: See Query.

Query Service:: The Couchbase service that executes SQL++ queries for data retrieval and manipulation, providing powerful querying capabilities across JSON documents.

Attribute, please.

Rebecca-Martinez007 · 2026-04-24T22:17:20Z

+
+SDK (Software Development Kit):: Client libraries and tools that enable applications to connect to and interact with Couchbase, available for Java, .NET, Python, Node.js, Go, C, C++, and other languages.
+
+Search:: The Couchbase service providing full-text search, geospatial search, and vector search capabilities with linguistic analysis and relevance scoring.


Suggested change

Search:: The Couchbase service providing full-text search, geospatial search, and vector search capabilities with linguistic analysis and relevance scoring.

Search:: A full-text query performed against a search index to identify and retrieve documents based on unstructured text content, linguistic analysis, or specific field patterns.

Let me tweak this one. Ignoring for now.

Rebecca-Martinez007 · 2026-04-24T22:17:38Z

+
+Search Index:: An index designed for full-text and vector search, supporting text analysis, custom analyzers, geospatial queries, and complex search operations.
+
+Search Service:: See Search.


Suggested change

Search Service:: See Search.

Search Service:: The Couchbase service providing full-text search, geospatial search, and vector search capabilities with linguistic analysis and relevance scoring.

Again, I will tweak this one, ignoring for now.

Rebecca-Martinez007 · 2026-04-24T22:19:20Z

+
+Workflow:: In Capella AI Services, a coordinated set of operations for data processing and vectorization, automating AI pipeline tasks.
+
+Workbench:: See Query Workbench.


I'm wondering if we should just remove this?

I think I'm okay with leaving this until we make sure everything uses the same, consistent terms everywhere.

simon-dew

please make sure to come back and add links to further explanations!

As requested, some links for more information.

simon-dew · 2026-04-30T14:05:02Z

+
+Namespace:: The highest level in the hierarchical organization of data in Couchbase.
+Two namespaces are available: `default` and `system`.
+Buckets, scopes, and collections are stored in the `default` namespace.


This is a link to the Server docs. I'm not sure if that's the best place as it's equally applicable to Capella?

Suggested change

Buckets, scopes, and collections are stored in the `default` namespace.

Buckets, scopes, and collections are stored in the `default` namespace.

For more information, see xref:server:n1ql:n1ql-intro/queriesandresults.adoc#logical-hierarchy[Logical Hierarchy].

We could always just link to both, instead.

Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com> Co-authored-by: Rebecca Martinez <167447972+Rebecca-Martinez007@users.noreply.github.com>

[AV-41998] Initial commit of glossary.adoc. Exact location in nav TBD

08f3aab

sarahlwelton self-assigned this Mar 30, 2026

simon-dew requested changes Mar 31, 2026

View reviewed changes

Apply suggestions from code review

f1cc790

Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>

[AV-41998] Add some more Search-specific terms. Remove all bold marku…

9713d46

…p from entries

rakhi-prathap reviewed Apr 1, 2026

View reviewed changes

Rebecca-Martinez007 reviewed Apr 24, 2026

View reviewed changes

simon-dew requested changes Apr 30, 2026

View reviewed changes

Apply suggestions from code review

077ac7f

Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com> Co-authored-by: Rebecca Martinez <167447972+Rebecca-Martinez007@users.noreply.github.com>


		== C

		Capella:: Couchbase's fully managed database-as-a-service (DBaaS) platform that runs on cloud infrastructure (AWS, Azure, GCP), providing operational databases, analytics, App Services, and AI capabilities without requiring server management.


		Primary Index:: An index covering all documents in a collection using the document key, enabling queries without secondary indexes and supporting full collection scans.

		Private Endpoint:: A network interface for accessing Capella services through private network connections rather than the public Internet, enhancing security and performance.

	Private Endpoint:: A network interface for accessing Capella services through private network connections rather than the public Internet, enhancing security and performance.
	Private Endpoint:: A network interface for accessing Capella services through private network connections rather than the public Internet, enhancing security and performance.
	Private connectivity is provided through each cloud provider’s native private endpoint technology, including AWS PrivateLink on Amazon Web Services, Azure Private Link on Microsoft Azure, and Private Service Connect on Google Cloud Platform.


		== Q

		Query:: The Couchbase service that executes SQL++ queries for data retrieval and manipulation, providing powerful querying capabilities across JSON documents.

	Query:: The Couchbase service that executes SQL++ queries for data retrieval and manipulation, providing powerful querying capabilities across JSON documents.
	Query:: A specific SQL++ statement used to retrieve, filter, aggregate, or manipulate data stored within JSON documents.


		Query Plan:: The execution strategy generated by the Query Service for a SQL++ query, showing how the query is executed and which indexes are used.

		Query Service:: See Query.

	Query Service:: See Query.
	Query Service:: The Couchbase service that executes SQL++ queries for data retrieval and manipulation, providing powerful querying capabilities across JSON documents.


		SDK (Software Development Kit):: Client libraries and tools that enable applications to connect to and interact with Couchbase, available for Java, .NET, Python, Node.js, Go, C, C++, and other languages.

		Search:: The Couchbase service providing full-text search, geospatial search, and vector search capabilities with linguistic analysis and relevance scoring.

	Search:: The Couchbase service providing full-text search, geospatial search, and vector search capabilities with linguistic analysis and relevance scoring.
	Search:: A full-text query performed against a search index to identify and retrieve documents based on unstructured text content, linguistic analysis, or specific field patterns.


		Search Index:: An index designed for full-text and vector search, supporting text analysis, custom analyzers, geospatial queries, and complex search operations.

		Search Service:: See Search.

	Search Service:: See Search.
	Search Service:: The Couchbase service providing full-text search, geospatial search, and vector search capabilities with linguistic analysis and relevance scoring.


		Workflow:: In Capella AI Services, a coordinated set of operations for data processing and vectorization, automating AI pipeline tasks.

		Workbench:: See Query Workbench.

	Buckets, scopes, and collections are stored in the `default` namespace.
	Buckets, scopes, and collections are stored in the `default` namespace.
	For more information, see xref:server:n1ql:n1ql-intro/queriesandresults.adoc#logical-hierarchy[Logical Hierarchy].

Conversation

sarahlwelton commented Mar 30, 2026

Uh oh!

simon-dew left a comment • 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!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarahlwelton commented Mar 31, 2026

Uh oh!

rakhi-prathap left a comment

Choose a reason for hiding this comment

Uh oh!

sarahlwelton commented Apr 1, 2026

Uh oh!

Rebecca-Martinez007 left a comment

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!

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!

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!

simon-dew 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

simon-dew left a comment •

edited

Loading