Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
ea3faab
Fix various missed N1QL→SQL++
simon-dew Oct 11, 2023
d4e3895
Convert guide titles to actions
simon-dew Oct 29, 2023
e760815
Rearrange the global index reference
simon-dew Oct 30, 2023
df8b015
Update titles for SQL++ reference pages
simon-dew Jan 11, 2024
b51fcf9
Update nav for JavaScript UDFs
simon-dew Oct 31, 2023
b0794e4
Create combined nav for Query
simon-dew Oct 31, 2023
9ca1f51
Update pagination for select query guides
simon-dew Nov 10, 2023
2fb5a24
Update pagination for import guide
simon-dew Nov 10, 2023
8dc219a
Update Advanced Query Features landing page
simon-dew Nov 10, 2023
a4539f5
Update service descriptions
simon-dew Nov 17, 2023
de9a48c
Move Index Consistency from Queries and Results
simon-dew Nov 17, 2023
6a9d2d1
Move Index Building from Queries and Results
simon-dew Nov 17, 2023
4294a48
Updating Query page with Dina's suggestions
simon-dew Nov 17, 2023
543ebeb
Update Query Concepts page with Dina's suggestions
simon-dew Jan 12, 2024
d87d9bb
Fix pagination for Index Advisor guide
simon-dew Nov 17, 2023
e76e703
Update landing pages
simon-dew Oct 31, 2023
c14c7e6
Add Query Admin section;
simon-dew Nov 17, 2023
d9a9ed6
Update System Info page with Dina's suggestions
simon-dew Nov 17, 2023
db73584
Fix bugs
simon-dew Nov 17, 2023
53ae54f
Query Service Landing Page
simon-dew Nov 17, 2023
db67e3b
Run Queries
simon-dew Nov 17, 2023
95e97d7
Driveby fix for SELECT guide
simon-dew Jan 12, 2024
957a040
Correct example snippets in Guides
simon-dew Nov 17, 2023
4577f07
Transactions guide
simon-dew Jan 13, 2024
8e6adf0
Update transactions overview and guide
simon-dew Nov 21, 2023
0d6375b
Hide and redirect unused landing pages
simon-dew Nov 21, 2023
4c0f281
Fix mistake with landing page redirects
simon-dew Nov 21, 2023
c44c090
Add Developer Intro landing page;
simon-dew Nov 21, 2023
5991e9c
Add integrations page from Server;
simon-dew Nov 21, 2023
8a921a0
Minor tweaks
simon-dew Jan 13, 2024
b7088e0
Fix up KV operations devex guides
simon-dew Nov 22, 2023
ed693b6
AV-61582 style fix (use of we)
simon-dew Nov 22, 2023
e497cbf
Add Terraform to new integrations page
simon-dew Jan 18, 2024
5c29879
Remove guides intro page
simon-dew Jan 18, 2024
4c96710
Update combined nav for Connect and Data
simon-dew Jan 18, 2024
123f1f2
Update search nav: promote everything one step in hierarchy
simon-dew Jan 18, 2024
3804297
Add signpost partial with component logos
simon-dew Jan 31, 2024
54aab7b
Add signpost partial and escape hatch to pages for consistency
simon-dew Jan 31, 2024
fcd0f84
Add signpost and enable escape hatch for Work with Your Data
simon-dew Jan 31, 2024
85724bc
Enable escape hatch for Import and Export Data
simon-dew Jan 31, 2024
510d722
Replace escape hatch with component signpost in Developer Intro
simon-dew Jan 31, 2024
82bd8e0
Replace other guide link with component signpost
simon-dew Jan 31, 2024
de4eb58
Remove escape hatch and other guide partials
simon-dew Jan 31, 2024
b68fde7
SQL++ landing page is a reference
simon-dew Jan 31, 2024
ed0b3a2
Update admin landing page for Server
simon-dew Feb 1, 2024
1875308
Add the CBQ, manage and monitoring pages to the Query nav
simon-dew Feb 1, 2024
314ad3c
Add Manage Documents page to KV nav
simon-dew Feb 1, 2024
9718abe
Relocate JavaScript UDFs
simon-dew Feb 1, 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.
7 changes: 7 additions & 0 deletions modules/ROOT/partials/component-signpost.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[.signpost]
image:ROOT:couchbase-logo.svg["Couchbase Server", 25.6]
This page is for Couchbase Server.
ifdef::flag-devex-escape-hatch[]
// soft-set flag-devex-escape-hatch so authors can override the escape hatch for individual pages
For Couchbase Capella, see xref:cloud:{page-module}:{docname}.adoc[].
endif::flag-devex-escape-hatch[]
52 changes: 29 additions & 23 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,57 +21,63 @@ 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:kv-operations.adoc[]

== Query Service Information
== Query

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.
Use the Query Service and the Index Service to issue {sqlpp} queries to extract and manipulate data.

* xref:n1ql:query.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

The Analytics Service is a parallel data management capability for Couchbase Server, designed to run ad-hoc, analytical queries efficiently over many records.
Use the Analytics Service for online analytical processing (OLAP) for large datasets, with complex analytical or ad hoc queries.

* xref:analytics:introduction.adoc[Introduction to Analytics]

== SDKs

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

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

== Integrations

Integrations that Couchbase or partners have developed to enhance Couchbase, Capella, and partner services --
Integrations that Couchbase or partners have developed to enhance Couchbase Server and partner services --
a vital tool for many larger development projects.

* xref:develop:integrations.adoc[]
* 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
7 changes: 3 additions & 4 deletions modules/guides/pages/call-user-defined-function.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@
:flag-devex-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
7 changes: 3 additions & 4 deletions modules/guides/pages/connect.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 3 additions & 4 deletions modules/guides/pages/create-javascript-library.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@
:flag-devex-escape-hatch!:

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

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

== Introduction

Expand Down
7 changes: 3 additions & 4 deletions modules/guides/pages/create-user-defined-function.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@
:flag-devex-escape-hatch!:

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

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

[#creating-the-n1ql-udf-function]
== Creating the {sqlpp} User-Defined Function
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
44 changes: 44 additions & 0 deletions modules/guides/pages/data.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
= Work with Your Data
:page-role: tiles -toc
:description: The Data Service offers Couchbase clients the fastest and simplest way to create, retrieve, or mutate data.
:!sectids:

// Pass through HTML styles for this page.

ifdef::basebackend-html[]
++++
<style type="text/css">
/* Extend heading across page width */
div.page-heading-title,
div.contributor-list-box,
div#preamble,
nav.pagination {
flex-basis: 100%;
}
</style>
++++
endif::[]

[abstract]
{description}

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

== Key-Value Operations

Use the Couchbase Web Console or an SDK to create, read, update, or delete data.

* xref:kv-operations.adoc[]

== Import and Export

Use the Couchbase Web Console, an SDK, or a command-line tool to import data.
Use a command-line tool to export data.

* xref:load.adoc[]

== Related Links

Refer to the following for information on the Data Service.

* xref:learn:services-and-indexes/services/data-service.adoc[]
Loading