Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
0ed19dd
Fix various missed N1QL→SQL++
simon-dew Oct 11, 2023
5ca1035
Convert guide titles to actions
simon-dew Oct 29, 2023
0770ac7
Rearrange the global index reference
simon-dew Oct 30, 2023
1bf4b92
Update titles for SQL++ reference pages
simon-dew Jan 11, 2024
ed91428
Update nav for JavaScript UDFs
simon-dew Oct 31, 2023
27c3b94
Create combined nav for Query
simon-dew Oct 31, 2023
546e7a0
Update pagination for select query guides
simon-dew Nov 10, 2023
927ad7f
Update pagination for import guide
simon-dew Nov 10, 2023
d4fecd7
Update Advanced Query Features landing page
simon-dew Nov 10, 2023
7290df0
Update service descriptions
simon-dew Nov 17, 2023
ceaa989
Move Index Consistency from Queries and Results
simon-dew Nov 17, 2023
e7533c8
Move Index Building from Queries and Results
simon-dew Nov 17, 2023
89b298f
Updating Query page with Dina's suggestions
simon-dew Nov 17, 2023
0dca02e
Update Query Concepts page with Dina's suggestions
simon-dew Jan 12, 2024
e9b30b1
Fix pagination for Index Advisor guide
simon-dew Nov 17, 2023
7e49c19
Update landing pages
simon-dew Oct 31, 2023
61570af
Add Query Admin section;
simon-dew Nov 17, 2023
5148f2f
Update System Info page with Dina's suggestions
simon-dew Nov 17, 2023
975058c
Fix bugs
simon-dew Nov 17, 2023
9b375b7
Query Service Landing Page
simon-dew Nov 17, 2023
d4e1984
Run Queries
simon-dew Nov 17, 2023
cf4c02c
Driveby fix for SELECT guide
simon-dew Jan 12, 2024
9a21305
Correct example snippets in Guides
simon-dew Nov 17, 2023
ca475e8
Transactions guide
simon-dew Jan 13, 2024
aa2b78e
Update transactions overview and guide
simon-dew Nov 21, 2023
ef0740e
Hide and redirect unused landing pages
simon-dew Nov 21, 2023
6907965
Fix mistake with landing page redirects
simon-dew Nov 21, 2023
c0f8424
Add Developer Intro landing page;
simon-dew Nov 21, 2023
1796549
Add integrations page from Server;
simon-dew Nov 21, 2023
41e6262
Minor tweaks
simon-dew Jan 13, 2024
b0fb700
Fix up KV operations devex guides
simon-dew Nov 22, 2023
67c1ba0
AV-61582 style fix (use of we)
simon-dew Nov 22, 2023
648e262
Add LangChain and Terraform to new integrations page
simon-dew Jan 18, 2024
51b0257
Remove guides intro page
simon-dew Jan 18, 2024
a57bd28
Update combined nav for Connect and Data
simon-dew Apr 11, 2024
73a5d81
Update search nav: promote everything one step in hierarchy
simon-dew Jan 18, 2024
606e897
Add signpost partial with component logos
simon-dew Jan 31, 2024
b2d0d11
Add signpost partial and escape hatch to pages for consistency
simon-dew Jan 31, 2024
54e6873
Add signpost and enable escape hatch for Work with Your Data
simon-dew Jan 31, 2024
82ef35e
Enable escape hatch for Import and Export Data
simon-dew Jan 31, 2024
0d4b59b
Replace escape hatch with component signpost in Developer Intro
simon-dew Jan 31, 2024
e1c03e6
Replace other guide link with component signpost
simon-dew Jan 31, 2024
530662f
Remove escape hatch and other guide partials
simon-dew Jan 31, 2024
9415747
SQL++ landing page is a reference
simon-dew Jan 31, 2024
0707cfa
Update admin landing page for Server
simon-dew Feb 1, 2024
a6064a0
Add the CBQ, manage and monitoring pages to the Query nav
simon-dew Feb 1, 2024
e428577
Add Manage Documents page to KV nav
simon-dew Feb 1, 2024
74d7930
Relocate JavaScript UDFs
simon-dew Feb 1, 2024
bae632e
Add Vector Search to Developer Intro
simon-dew Mar 27, 2024
a5eca45
Update title of Connect guide
simon-dew Mar 27, 2024
688f61d
No need to call it a language reference
simon-dew Mar 28, 2024
7e332ad
Settings as separate section
simon-dew Mar 28, 2024
aa3656c
Add backfill and auditing to admin
simon-dew Mar 28, 2024
fefc06d
Add sequence expressions to SQL++ overview
simon-dew Mar 29, 2024
5c37abf
Delete unused import / export nav link
simon-dew Mar 29, 2024
1afc38a
Update title of Flex Indexes: action first
simon-dew Apr 1, 2024
7ad58c4
Update Manage Documents link
simon-dew Apr 3, 2024
57ededa
Minor tweaks.
simon-dew Apr 3, 2024
613da7c
Update component signpost partial, use no-escape-hatch attrib
simon-dew Apr 4, 2024
00e18a1
Minor formatting changes for auditing and backfill
simon-dew Apr 4, 2024
5148e55
GSI overview page: add query without index, ADVISE
simon-dew Apr 4, 2024
24d8e13
Fix link to Data on Developer Intro page
simon-dew Apr 5, 2024
e401bd8
flag-devex-escape-hatch covers entire signpost
simon-dew Apr 5, 2024
0c9cc39
Make server logo blue
simon-dew Apr 5, 2024
1bd2d39
Fix page alias in Developer Intro
simon-dew Apr 10, 2024
c0498be
Add Query icon for language signpost
simon-dew Apr 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions modules/ROOT/images/capella-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions modules/ROOT/images/couchbase-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions modules/ROOT/partials/component-signpost.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// `flag-devex-escape-hatch` is a flag to hide the feature from production until ready.
// Use `no-escape-hatch` to turn off the escape hatch for individual pages.
// Use `escape-hatch` to override the escape hatch xref for individual pages.
ifdef::flag-devex-escape-hatch[]
[.signpost]
image:ROOT:couchbase-logo.svg["Couchbase Server", 25.6]
This page is for Couchbase Server.
ifndef::no-escape-hatch[]
For Couchbase Capella, see
ifdef::escape-hatch[]
xref:{escape-hatch}[].
endif::escape-hatch[]
ifndef::escape-hatch[]
xref:cloud:{page-module}:{docname}.adoc[].
endif::escape-hatch[]
endif::no-escape-hatch[]
endif::flag-devex-escape-hatch[]
66 changes: 40 additions & 26 deletions modules/develop/pages/intro.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Developer's Intro
= Developer Intro
:page-role: tiles -toc
:description: This section contains tutorials, how-to guides, and information about Couchbase Services to help you develop applications.
:!sectids:
:page-aliases: concepts:application-development
:page-aliases: concepts:application-development,guides:intro.adoc

// Pass through HTML styles for this page.

Expand All @@ -21,56 +21,70 @@ ifdef::basebackend-html[]
endif::[]

{description}
It also provides links to the documentation for software development kits and starter kits.
It also provides links to the documentation for software development kits and other integrations.

include::partial$escape-hatch.adoc[]
include::ROOT:partial$component-signpost.adoc[]

== Developer Tutorial

This tutorial provides an introductory worked example for developers, showing how to use a software development kit with a simple database.

* xref:tutorials:couchbase-tutorial-student-records.adoc[]

== Developer Guides
== Connect

These how-to guides walk you through common tasks for Couchbase Server development, such as storing, retrieving, and querying documents.
Choose how you want to connect your app to Couchbase Server.

* xref:guides:intro.adoc[Developer Guides]
* xref:guides:connect.adoc[]

== SDKs
== Data

Couchbase offers numerous software development kits (SDKs) that provide programmatic access to Couchbase Server.
Use the Data Service for key-value (CRUD) operations and to import or export data.

* xref:home:ROOT:sdk.adoc[]
* xref:guides:data.adoc[]

== Starter Kits
== Query

Starter kits are repositories containing example code to get you started with various development projects.
Use the Query Service and the Index Service to issue {sqlpp} queries to extract and manipulate data.

* xref:getting-started:starter-kits.adoc[]
* xref:n1ql:query.adoc[]

== Query Service Information
== Vector Search

The Query Service enables you to issue queries to extract data from Couchbase clusters.
You can also issue queries for defining indexes and data manipulation.
Vector Search builds on the Search Service to provide support for vector indexes.
You can use vector indexes with existing Large Language Models to develop AI applications.

* xref:n1ql:query.adoc[]
* xref:vector-search:vector-search.adoc[]

== Search Service Information
== Search

The Search Service (Full Text Search or FTS) enables you to create and manage full-text indexes, and provides extensive capabilities for natural-language and geospatial queries.
Use the Search Service for full-text search with natural language processing across multiple data types and languages.
Use custom text analysis, Geospatial search, and more.

* xref:fts:fts-introduction.adoc[]
* xref:search:search.adoc[]

== Eventing Service Information
== Eventing

The Eventing Service provides near real-time handling of changes to data.
It enables you to execute code either in response to mutations, or as scheduled by timers.
Use the Eventing Service to respond to changes to your data in near real-time.
Execute custom code in response to mutations, or as scheduled by timers.

* xref:eventing:eventing-overview.adoc[]

== Analytics Service Information
== Analytics

Use the Analytics Service for online analytical processing (OLAP) for large datasets, with complex analytical or ad hoc queries.

* xref:analytics:introduction.adoc[]

== SDKs

Couchbase offers numerous software development kits (SDKs) that provide programmatic access to Couchbase Server.

* xref:home:ROOT:sdk.adoc[]

== Integrations

The Analytics Service is a parallel data management capability for Couchbase Server, designed to run ad-hoc, analytical queries efficiently over many records.
Integrations that Couchbase or partners have developed to enhance Couchbase Server and partner services --
a vital tool for many larger development projects.

* xref:analytics:introduction.adoc[Introduction to Analytics]
* xref:third-party:integrations.adoc[]
8 changes: 0 additions & 8 deletions modules/develop/partials/escape-hatch.adoc

This file was deleted.

3 changes: 1 addition & 2 deletions modules/develop/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
* xref:develop:intro.adoc[Developer's Intro]
* xref:develop:integrations.adoc[Third Party Integrations]
* xref:develop:intro.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ endif::[]

This section contains _how-to guides_ that walk you through common tasks for Couchbase Server development, such as storing, retrieving, and querying documents.

include::partial$other-guide.adoc[]
include::ROOT:partial$component-signpost.adoc[]

== Connecting to Couchbase

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,9 @@ ifdef::basebackend-html[]
++++
endif::[]

{description} +
include::partial$other-guide.adoc[]
{description}

== Prepared Statements

include::prep-statements.adoc[tags=intro]

* xref:prep-statements.adoc[]
include::ROOT:partial$component-signpost.adoc[]

== Index Advisor

Expand Down
11 changes: 5 additions & 6 deletions modules/guides/pages/bulk-operations.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Bulk Operations
:description: How to perform bulk CRUD operations in Couchbase.
= Work with Documents in Bulk
:description: How to perform bulk CRUD operations with a command line tool or an SDK.
:page-pagination: prev
:page-topic-type: guide
:tabs:
Expand All @@ -8,10 +8,9 @@
include::partial$example-attributes.adoc[]

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
9 changes: 4 additions & 5 deletions modules/guides/pages/call-user-defined-function.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@
:page-topic-type: guide
:page-toclevels: 2
:imagesdir: ../assets/images
:flag-devex-escape-hatch!:
:no-escape-hatch:

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
9 changes: 4 additions & 5 deletions modules/guides/pages/cbo.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Cost-Based Optimizer
= Use the Cost-Based Optimizer with Queries
:page-topic-type: guide
:page-partial:
:page-pagination: prev
Expand All @@ -7,10 +7,9 @@
:description: How to use the Cost-Based Optimizer and manage optimizer statistics.

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
9 changes: 4 additions & 5 deletions modules/guides/pages/connect.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Connecting to Couchbase Server
= Connect to Couchbase Server
:description: How to connect to a Couchbase Cluster.
:page-topic-type: guide
:page-toclevels: 2
Expand All @@ -9,10 +9,9 @@
include::partial$example-attributes.adoc[]

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
9 changes: 4 additions & 5 deletions modules/guides/pages/create-index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Creating Indexes
= Create Indexes
:page-topic-type: guide
:imagesdir: ../assets/images
:page-partial:
Expand All @@ -9,10 +9,9 @@
:description: How to create primary indexes and secondary indexes.

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
9 changes: 4 additions & 5 deletions modules/guides/pages/create-javascript-library.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@
:page-topic-type: guide
:page-toclevels: 2
:imagesdir: ../assets/images
:flag-devex-escape-hatch!:
:no-escape-hatch:

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
9 changes: 4 additions & 5 deletions modules/guides/pages/create-user-defined-function.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@
:page-toclevels: 2
:keywords: N1QL, UDF, user-defined function, SQL++
:imagesdir: ../assets/images
:flag-devex-escape-hatch!:
:no-escape-hatch:

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
11 changes: 5 additions & 6 deletions modules/guides/pages/creating-data.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Creating Data
:description: How to create documents in Couchbase.
= Create Documents
:description: How to create documents with a command line tool or an SDK.
:page-pagination: full
:page-topic-type: guide
:page-toclevels: 2
Expand All @@ -9,10 +9,9 @@
include::partial$example-attributes.adoc[]

[abstract]
--
{description} +
include::partial$other-guide.adoc[]
--
{description}

include::ROOT:partial$component-signpost.adoc[]

== Introduction

Expand Down
Loading