Skip to content

Commit 3248201

Browse files
committed
DOC-11702: IA Phase 2 — Backport IA refresh to server (#175)
* Fix various missed N1QL→SQL++ * Convert guide titles to actions * Rearrange the global index reference * Update titles for SQL++ reference pages * Update nav for JavaScript UDFs * Create combined nav for Query * Update pagination for select query guides * Update pagination for import guide * Update Advanced Query Features landing page * Update service descriptions * Move Index Consistency from Queries and Results to Index Availability and Performance. * Move Index Building from Queries and Results to Index Lifecycle * Updating Query page with Dina's suggestions * Update Query Concepts page with Dina's suggestions * Fix pagination for Index Advisor guide * Update landing pages * Add Query Admin section; move System Information and Manage Indexes sections into it * Update System Info page with Dina's suggestions * Query Service Landing Page * Run Queries * Driveby fix for SELECT guide * Correct example snippets in Guides * Update transactions overview and guide * Delete and redirect unused landing pages * Add Developer Intro landing page; delete and redirect Guides landing page * Add integrations page from Server; update Developer Intro page * Fix up KV operations devex guides * AV-61582 style fix (use of we) * Add LangChain and Terraform to new integrations page and delete original * Remove guides intro page * Update combined nav for Connect and Data * Update search nav: promote everything one step in hierarchy * Add signpost partial with component logos * Add signpost partial and escape hatch to pages for consistency * Add signpost and enable escape hatch for Work with Your Data * Enable escape hatch for Import and Export Data * Replace escape hatch with component signpost in Developer Intro * Replace other guide link with component signpost * Remove escape hatch and other guide partials * SQL++ landing page is a reference * Update admin landing page for Server * Add the CBQ, manage and monitoring pages to the Query nav — hide auditing and backfill pages for now * Add Manage Documents page to KV nav * Relocate JavaScript UDFs * Add Vector Search to Developer Intro * Update title of Connect guide * No need to call it a language reference * Settings as separate section * Add backfill and auditing to admin * Add sequence expressions to SQL++ overview * Delete unused import / export nav link * Update title of Flex Indexes: action first * Update Manage Documents link * Put settings and parameters back under Admin. * Update component signpost partial, use no-escape-hatch attrib * Minor formatting changes for auditing and backfill * GSI overview page: add query without index, ADVISE * Fix link to Data on Developer Intro page * flag-devex-escape-hatch covers entire signpost * Make server logo blue * Fix page alias in Developer Intro * Add Query icon for language signpost
1 parent 06b8a33 commit 3248201

File tree

78 files changed

+962
-902
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+962
-902
lines changed
Lines changed: 7 additions & 0 deletions
Loading
Lines changed: 50 additions & 0 deletions
Loading
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// `flag-devex-escape-hatch` is a flag to hide the feature from production until ready.
2+
// Use `no-escape-hatch` to turn off the escape hatch for individual pages.
3+
// Use `escape-hatch` to override the escape hatch xref for individual pages.
4+
ifdef::flag-devex-escape-hatch[]
5+
[.signpost]
6+
image:ROOT:couchbase-logo.svg["Couchbase Server", 25.6]
7+
This page is for Couchbase Server.
8+
ifndef::no-escape-hatch[]
9+
For Couchbase Capella, see
10+
ifdef::escape-hatch[]
11+
xref:{escape-hatch}[].
12+
endif::escape-hatch[]
13+
ifndef::escape-hatch[]
14+
xref:cloud:{page-module}:{docname}.adoc[].
15+
endif::escape-hatch[]
16+
endif::no-escape-hatch[]
17+
endif::flag-devex-escape-hatch[]

modules/develop/pages/intro.adoc

Lines changed: 40 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
= Developer's Intro
1+
= Developer Intro
22
:page-role: tiles -toc
33
:description: This section contains tutorials, how-to guides, and information about Couchbase Services to help you develop applications.
44
:!sectids:
5-
:page-aliases: concepts:application-development
5+
:page-aliases: concepts:application-development,guides:intro.adoc
66

77
// Pass through HTML styles for this page.
88

@@ -21,56 +21,70 @@ ifdef::basebackend-html[]
2121
endif::[]
2222

2323
{description}
24-
It also provides links to the documentation for software development kits and starter kits.
24+
It also provides links to the documentation for software development kits and other integrations.
2525

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

2828
== Developer Tutorial
2929

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

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

34-
== Developer Guides
34+
== Connect
3535

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

38-
* xref:guides:intro.adoc[Developer Guides]
38+
* xref:guides:connect.adoc[]
3939

40-
== SDKs
40+
== Data
4141

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

44-
* xref:home:ROOT:sdk.adoc[]
44+
* xref:guides:data.adoc[]
4545

46-
== Starter Kits
46+
== Query
4747

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

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

52-
== Query Service Information
52+
== Vector Search
5353

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

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

59-
== Search Service Information
59+
== Search
6060

61-
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.
61+
Use the Search Service for full-text search with natural language processing across multiple data types and languages.
62+
Use custom text analysis, Geospatial search, and more.
6263

63-
* xref:fts:fts-introduction.adoc[]
64+
* xref:search:search.adoc[]
6465

65-
== Eventing Service Information
66+
== Eventing
6667

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

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

72-
== Analytics Service Information
73+
== Analytics
74+
75+
Use the Analytics Service for online analytical processing (OLAP) for large datasets, with complex analytical or ad hoc queries.
76+
77+
* xref:analytics:introduction.adoc[]
78+
79+
== SDKs
80+
81+
Couchbase offers numerous software development kits (SDKs) that provide programmatic access to Couchbase Server.
82+
83+
* xref:home:ROOT:sdk.adoc[]
84+
85+
== Integrations
7386

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

76-
* xref:analytics:introduction.adoc[Introduction to Analytics]
90+
* xref:third-party:integrations.adoc[]

modules/develop/partials/escape-hatch.adoc

Lines changed: 0 additions & 8 deletions
This file was deleted.

modules/develop/partials/nav.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
* xref:develop:intro.adoc[Developer's Intro]
2-
* xref:develop:integrations.adoc[Third Party Integrations]
1+
* xref:develop:intro.adoc[]

modules/guides/pages/bulk-operations.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Bulk Operations
2-
:description: How to perform bulk CRUD operations in Couchbase.
1+
= Work with Documents in Bulk
2+
:description: How to perform bulk CRUD operations with a command line tool or an SDK.
33
:page-pagination: prev
44
:page-topic-type: guide
55
:tabs:
@@ -8,10 +8,9 @@
88
include::partial$example-attributes.adoc[]
99

1010
[abstract]
11-
--
12-
{description} +
13-
include::partial$other-guide.adoc[]
14-
--
11+
{description}
12+
13+
include::ROOT:partial$component-signpost.adoc[]
1514

1615
== Introduction
1716

modules/guides/pages/call-user-defined-function.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@
55
:page-topic-type: guide
66
:page-toclevels: 2
77
:imagesdir: ../assets/images
8-
:flag-devex-escape-hatch!:
8+
:no-escape-hatch:
99

1010
[abstract]
11-
--
12-
{description} +
13-
include::partial$other-guide.adoc[]
14-
--
11+
{description}
12+
13+
include::ROOT:partial$component-signpost.adoc[]
1514

1615
== Introduction
1716

modules/guides/pages/cbo.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Cost-Based Optimizer
1+
= Use the Cost-Based Optimizer with Queries
22
:page-topic-type: guide
33
:page-partial:
44
:page-pagination: prev
@@ -7,10 +7,9 @@
77
:description: How to use the Cost-Based Optimizer and manage optimizer statistics.
88

99
[abstract]
10-
--
11-
{description} +
12-
include::partial$other-guide.adoc[]
13-
--
10+
{description}
11+
12+
include::ROOT:partial$component-signpost.adoc[]
1413

1514
== Introduction
1615

modules/guides/pages/connect.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Connecting to Couchbase Server
1+
= Connect to Couchbase Server
22
:description: How to connect to a Couchbase Cluster.
33
:page-topic-type: guide
44
:page-toclevels: 2
@@ -9,10 +9,9 @@
99
include::partial$example-attributes.adoc[]
1010

1111
[abstract]
12-
--
13-
{description} +
14-
include::partial$other-guide.adoc[]
15-
--
12+
{description}
13+
14+
include::ROOT:partial$component-signpost.adoc[]
1615

1716
== Introduction
1817

0 commit comments

Comments
 (0)