Skip to content

Commit 5aad267

Browse files
osfameronRichardSmedleyCopilot
authored
DOC-13407 Enterprise Analytics GA (#832)
* DOC-13407 Enterprise Analytics GA This PR: - updates the Nav: - renames `columnar` to `analytics` as per main@docs-columnar change - adds `enterprise-analytics` to Server section - folds in @RichardSmedley's changes to Analytics SDK section, both sources and startPage - updates UI to prod-214 (includes "Analytics" label rename) - updates the sources for docs-columnar, with comments. - the legacy `columnar` component allows us to set a page alias from "columnar" to "analytics", reducing the scope of PRs in different components that already referred to columnar. - adds sources for new "analytics SDK" (as opposed to "columnar SDK" which continue to exist side-by-side for now) * update preview playbook with Analytics SDKs * Rebrand Capella Analytics (retain "Columnar SDK" for now) retaining Columnar SDK for now, as I don't understand the spec, for @RichardSmedley / @zeba-shireen to agree. * honour remote override of docs-site branch * update columnar to release/2.0 The first release is 2.0, 😕 * Update {sqlppc} * top nav dropdown * Remove duplicate line * update UI bundle * indentation issue Co-authored-by: Copilot <[email protected]> * no longer cloud-only * Analytics SDKs in main landing page * add Enterprise Analytics links to landing page --------- Co-authored-by: Richard Smedley <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent cf06bc3 commit 5aad267

File tree

5 files changed

+118
-53
lines changed

5 files changed

+118
-53
lines changed

antora-playbook.yml

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,26 @@ site:
2828
# see https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/2963243023/FAQ+how+does+the+top+nav+bar+work
2929
nav_groups: |
3030
[
31-
{ "title": "Server", "startPage": "home::server.adoc", "components": ["server"] },
31+
{ "title": "Server", "startPage": "home::server.adoc", "components": ["server", "enterprise-analytics"] },
3232
{ "title": "Mobile / Edge", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "sync-gateway", "couchbase-edge-server"] },
33-
{ "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "columnar"] },
33+
{ "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "analytics"] },
3434
{ "title": "Cloud-Native", "components": ["cloud-native-database"] },
3535
{ "title": "Kubernetes Operator", "startPage": "operator::overview.adoc", "components": ["operator"] },
3636
{ "title": "CMOS", "components": ["cmos"] },
37-
{ "title": "Couchbase SDKs", "startPage": "home::sdk.adoc", "components": ["dotnet-sdk", "efcore-provider", "c-sdk", "cxx-sdk", "go-sdk", "java-sdk", "quarkus-extension", "kotlin-sdk", "nodejs-sdk", "php-sdk", "python-sdk", "ruby-sdk", "scala-sdk", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "superset-connector", "sdk-extensions"] },
38-
{ "title": "Columnar SDKs", "startPage": "home::columnar-sdk.adoc", "components": ["*-columnar-sdk"] },
37+
{ "title": "Develop", "startPage": "home::developer.adoc",
38+
"subGroups": [
39+
{
40+
"title": "Operational SDKs",
41+
"startPage": "home::sdk.adoc",
42+
"components": ["develop", "dotnet-sdk", "efcore-provider", "c-sdk", "cxx-sdk", "go-sdk", "java-sdk", "quarkus-extension", "kotlin-sdk", "nodejs-sdk", "php-sdk", "python-sdk", "ruby-sdk", "scala-sdk", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "superset-connector", "sdk-extensions"]
43+
},
44+
{
45+
"title": "Analytics SDKs",
46+
"startPage": "home::analytics-sdk.adoc",
47+
"components": ["*-analytics-sdk", "*-columnar-sdk"]
48+
}
49+
]
50+
},
3951
{ "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] },
4052
{ "title": "Contribute", "components": ["home", "styleguide", "ui-ux", "pendo"] }
4153
]
@@ -62,6 +74,7 @@ content:
6274
- url: .
6375
branches: HEAD
6476
start_path: home
77+
6578
- url: https://github.com/couchbaselabs/docs-style-guide
6679
branches: main
6780
start_paths: [styleguide, ui-ux, pendo]
@@ -81,8 +94,12 @@ content:
8194
start_paths: [docs/public, docs/columnar]
8295
- url: https://github.com/couchbase/docs-capella
8396
branches: [main]
97+
8498
- url: https://github.com/couchbaselabs/docs-columnar
85-
branches: [main]
99+
branches:
100+
- main # `analytics` component (Capella Analytics)
101+
- release/2.0 # `enterprise-analytics` component (self-managed)
102+
- legacy-columnar-component # `columnar` dummy component for sake of :page-aliases:
86103

87104
# Couchbase Autonomous Kubernetes Operator
88105
############################
@@ -122,7 +139,7 @@ content:
122139
branches: [release/1.0]
123140
- url: https://github.com/couchbase/docs-connectors-talend
124141

125-
# Server related sections
142+
# Server
126143
############################
127144

128145
- url: https://github.com/couchbase/docs-analytics
@@ -134,8 +151,6 @@ content:
134151
branches: [trinity, neo, 7.1.x-docs, cheshire-cat]
135152
start_path: docs
136153

137-
# docs-server
138-
############################
139154
# NOTE docs-server is currently after other server repos so nav key wins
140155

141156
- url: https://github.com/couchbase/docs-server
@@ -184,7 +199,7 @@ content:
184199
- url: https://github.com/couchbase/docs-sdk-extensions
185200
branches: [main]
186201

187-
# Columnar SDKs
202+
# Analytics SDKs (aka Columnar)
188203
############################
189204

190205
- url: https://github.com/couchbase/docs-columnar-sdk-common
@@ -199,6 +214,18 @@ content:
199214
- url: https://github.com/couchbase/docs-columnar-sdk-python
200215
branches: [release/1.0]
201216

217+
- url: https://github.com/couchbase/docs-analytics-sdk-common
218+
branches: [release/1.0]
219+
220+
- url: https://github.com/couchbase/docs-analytics-sdk-go
221+
branches: [release/1.0]
222+
- url: https://github.com/couchbase/docs-analytics-sdk-java
223+
branches: [release/1.0]
224+
- url: https://github.com/couchbase/docs-analytics-sdk-nodejs
225+
branches: [release/1.0]
226+
- url: https://github.com/couchbase/docs-analytics-sdk-python
227+
branches: [release/1.0]
228+
202229
# Mobile
203230
############################
204231

@@ -259,7 +286,7 @@ asciidoc:
259286
enterprise: https://www.couchbase.com/products/editions[ENTERPRISE EDITION]
260287
community: https://www.couchbase.com/products/editions[COMMUNITY EDITION]
261288
sqlpp: SQL++
262-
sqlppc: SQL++ for Capella columnar
289+
sqlppc: SQL++ for Capella Analytics
263290
sqlppea: SQL++ for Enterprise Analytics
264291
sqlpp_url: https://www.couchbase.com/products/n1ql
265292
cbpp: Couchbase++
@@ -280,7 +307,7 @@ asciidoc:
280307

281308
ui:
282309
bundle:
283-
url: https://github.com/couchbase/docs-ui/releases/download/prod-210/ui-bundle.zip
310+
url: https://github.com/couchbase/docs-ui/releases/download/prod-215/ui-bundle.zip
284311
output:
285312
dir: ./public
286313
runtime:

home/modules/ROOT/pages/cloud.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ Get set up with an account and deploy a free tier operational cluster.
3636

3737

3838
[.card-box]
39-
=== icon:rocket[] Get Started With Capella Columnar
39+
=== icon:rocket[] Get Started With Capella Analytics
4040

4141
Create your account and follow our tutorial on how to load data into your columnar cluster.
4242

4343
* https://cloud.couchbase.com/sign-up[Sign Up^]
44-
* xref:columnar:intro:intro.adoc[]
45-
* xref:columnar:admin:prepare-project.adoc[]
46-
* xref:columnar:intro:examples.adoc[]
47-
* xref:columnar:query:workbench.adoc[]
44+
* xref:analytics:intro:intro.adoc[]
45+
* xref:analytics:admin:prepare-project.adoc[]
46+
* xref:analytics:intro:examples.adoc[]
47+
* xref:analytics:query:workbench.adoc[]

home/modules/ROOT/pages/columnar-sdk.adoc

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,39 @@
1-
= Develop with Capella Columnar
1+
= Develop with Capella Analytics
22
:page-layout: landing-page-top-level-sdk
33
:page-role: tiles
44
:page-rank: 75
55
:!sectids:
66

7-
= Develop with Capella Columnar
7+
= Develop with Capella Analytics
88

99
include::partial$info-banner.adoc[]
1010

11-
////
12-
TIP box on analytics, after EA GA.
13-
////
11+
xref:analytics:intro:intro.adoc[Capella Analytics] is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
12+
Capella Analytics is a standalone, managed offering from Couchbase under the Capella family of products --
13+
a self-managed xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] product is also available.
14+
15+
TIP
16+
.Which Analytics Service?
17+
====
18+
Capella Analytics and Enterprise Analytics are column-based real-time analytical databases.
19+
20+
Capella Analytics SDKs, also known as Columnar SDKs, are similar to the Enterprise Analytics SDKs.
21+
They must be used to connect to the current Capella Analytics Service, as it presents a different connection interface, without Enterprise Analytics' load balancer.
22+
23+
To connect to self-managed Enterprise Analytics, use our xref:analytics-sdk.adoc[Enterprise Analytics SDKs].
24+
25+
xref:server:learn:services-and-indexes/services/analytics-service.adoc[CBAS (Couchbase Analytics Service)] is our classic OLAP available as part of self-managed Couchbase Server and Capella Operational.
26+
Use the xref:sdk.adoc[operational SDKs] to develop for this service.
27+
====
1428

15-
xref:columnar:intro:intro.adoc[Capella Columnar] is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
16-
Capella Columnar is a standalone, cloud-only offering from Couchbase under the Capella family of products.
29+
30+
== SDK APIs to work with Capella Analytics:
1731

1832
Columnar SDKs are developed from the ground-up and while they maintain some syntactic similarities with the xref:sdk.adoc[operational SDKs],
19-
they are purpose built for Columnar's analytical use cases.
33+
they are purpose built for Capella Analytics's real-time analytical use cases.
2034
They support streaming APIs to handle large datasets, as well as the common features expected to be present in any modern database SDK --
2135
such as connection management and robust error handling.
2236

23-
== SDK APIs to work with Capella Columnar:
24-
2537

2638
[{tabs}]
2739
====
@@ -38,7 +50,7 @@ Java::
3850
--
3951
xref:java-columnar-sdk:hello-world:overview.adoc[Java Columnar SDK Docs] |
4052
xref:java-columnar-sdk:hello-world:start-using-sdk.adoc[Quickstart] |
41-
https://docs.couchbase.com/sdk-api/columnar-java-client[Java API Reference]
53+
https://docs.couchbase.com/sdk-api/couchbase-columnar-java-client[Java API Reference]
4254
--
4355
4456
Node.js::

home/modules/ROOT/pages/index.adoc

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@ xref:cloud::index.adoc[Couchbase Capella]
6464

6565
{empty} +
6666

67-
.Capella Columnar (RT-OLAP)
67+
.Capella Analytics (RT-OLAP)
6868

69-
Capella Columnar is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
70-
Capella Columnar is a standalone, cloud-only offering from Couchbase under the Capella family of products.
69+
Capella Analytics is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
70+
Capella Analytics is a standalone, cloud-only offering from Couchbase under the Capella family of products.
7171

72-
xref:columnar:intro:intro.adoc[Capella Columnar]
72+
xref:analytics:intro:intro.adoc[Capella Analytics]
7373

7474

7575
[.column]
@@ -81,6 +81,14 @@ Explore Couchbase Server, a modern, distributed document database with all the d
8181

8282
xref:server.adoc[Couchbase Server]
8383

84+
{empty} +
85+
86+
.Enterprise Analytics (RT-OLAP)
87+
88+
Enterprise Analytics is a self-managed analytical database (RT-OLAP) for real time apps and operational intelligence.
89+
90+
xref:analytics:intro:intro.adoc[Capella Analytics]
91+
8492
[.column]
8593
====== {empty}
8694
.Couchbase Mobile
@@ -113,8 +121,10 @@ xref:couchbase-edge-server:introduction:intro.adoc[Couchbase Edge Server]
113121
[.content]
114122
Couchbase SDKs allow applications to access a Couchbase cluster and the big data Connectors enable data exchange with other platforms.
115123

116-
xref:home:ROOT:sdk.adoc[Developer Docs] |
117-
xref:home:ROOT:columnar-sdk.adoc[Columnar SDKs]
124+
xref:home:ROOT:developer.adoc[Developer Docs] |
125+
xref:home:ROOT:sdk.adoc[Operational SDKs] |
126+
xref:home:ROOT:analytics-sdk.adoc[Enterprise Analytics SDKs] |
127+
xref:home:ROOT:columnar-sdk.adoc[Capella Analytics SDKs]
118128

119129
[.column]
120130
====== {empty}
@@ -190,16 +200,25 @@ https://forums.couchbase.com/[Community]
190200

191201
a| xref:cloud::index.adoc[Couchbase Capella]
192202

193-
xref:columnar:intro:intro.adoc[Capella Columnar]
203+
xref:analytics:intro:intro.adoc[Capella Analytics]
204+
205+
206+
194207

195208
a| xref:server.adoc[Couchbase Server]
196209

210+
xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics]
211+
197212
xref:operator::overview.adoc[Couchbase Autonomous Operator]
198213

199214
xref:service-broker::index.adoc[Couchbase Service Broker]
200215

201216
xref:cmos::index.adoc[Couchbase Monitoring and Observability Stack]
202217

218+
219+
220+
221+
203222
a| xref:java-sdk:hello-world:overview.adoc[Couchbase Java SDK]
204223

205224
xref:scala-sdk:hello-world:overview.adoc[Couchbase Scala SDK]
@@ -228,6 +247,16 @@ xref:kafka-connector::quickstart.adoc[Couchbase Kafka Connector]
228247

229248
xref:spark-connector::getting-started.adoc[Couchbase Spark Connector]
230249

250+
xref:go-analytics-sdk:hello-world:overview.adoc[Go Analytics SDK]
251+
252+
xref:java-analytics-sdk:hello-world:overview.adoc[Java Analytics SDK]
253+
254+
xref:nodejs-analytics-sdk:hello-world:overview.adoc[Node.js Analytics SDK]
255+
256+
xref:python-analytics-sdk:hello-world:overview.adoc[Python Analytics SDK]
257+
258+
xref:go-columnar-sdk:hello-world:overview.adoc[Go Columnar SDK]
259+
231260
xref:java-columnar-sdk:hello-world:overview.adoc[Java Columnar SDK]
232261

233262
xref:nodejs-columnar-sdk:hello-world:overview.adoc[Node.js Columnar SDK]

home/modules/ROOT/pages/sdk.adoc

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,13 @@ collection.reactive.upsert("document-key", json)
2828
[TIP]
2929
.Analytics SDKs
3030
====
31-
////
32-
SDKs for xref:analytics:intro:intro.adoc[Enterprise Analytics] --
31+
SDKs for xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] --
3332
Couchbase's analytical database (RT-OLAP) for real time apps and operational intelligence --
3433
are xref:analytics-sdk.adoc[available] for the Go, Java, Node.js, and Python platforms.
3534
36-
37-
SDKs for xref:columnar:intro:intro.adoc[Capella Analytics] are similar to the Enterprise Analytics SDKs.
35+
SDKs for xref:analytics:intro:intro.adoc[Capella Analytics] are similar to the Enterprise Analytics SDKs.
3836
They must be used to connect to the current Capella Analytics Service, as it presents a different connection interface, without Enterprise Analytics' load balancer.
3937
They are xref:columnar-sdk.adoc[available] for the Go, Java, Node.js, and Python platforms.
40-
////
41-
SDKs for xref:columnar:intro:intro.adoc[Capella Columnar] are xref:columnar-sdk.adoc[available] for the Go, Java, Node.js, and Python platforms.
4238
====
4339

4440
{empty} +
@@ -157,17 +153,17 @@ xref:sdk-extensions::distributed-acid-transactions.adoc[Distributed ACID Transac
157153

158154

159155

160-
////
156+
161157
{empty} +
162158

163159
== Enterprise Analytics SDKs
164160

165-
xref:enterprise-analytics:intro:intro.adoc[Capella Columnar] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
161+
xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
166162
xref:analytics-sdk.adoc[Analytics SDKs] are tailored to the APIs offered by this service.
167163

168-
[#table_columnar_sdk,cols="42,40,60,50"]
164+
[#table_analytics_sdk,cols="42,40,60,50"]
169165
|===
170-
| Columnar SDK | Documentation | Hello World Example | API Reference
166+
| Analytics SDK | Documentation | Hello World Example | API Reference
171167

172168
| Go Analytics SDK
173169
| xref:go-analytics-sdk:hello-world:overview.adoc[Docs]
@@ -189,15 +185,15 @@ xref:analytics-sdk.adoc[Analytics SDKs] are tailored to the APIs offered by this
189185
| xref:python-analytics-sdk:hello-world:start-using-sdk.adoc[Python Getting Started]
190186
| https://docs.couchbase.com/sdk-api/analytics-python-client/[Python Analytics API Reference]
191187
|===
192-
////
188+
193189

194190

195191
{empty} +
196192

197-
== Capella columnar SDKs
193+
== Capella Analytics SDKs
198194

199-
xref:columnar:intro:intro.adoc[Capella Columnar] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
200-
xref:columnar-sdk.adoc[Columnar SDKs] are tailored to the APIs offered by this service.
195+
xref:analytics:intro:intro.adoc[Capella Analytics] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
196+
xref:columnar-sdk.adoc[Columnar SDKs] for Capella Analytics are tailored to the APIs offered by this service.
201197

202198
[#table_columnar_sdk,cols="42,40,60,50"]
203199
|===
@@ -247,23 +243,23 @@ xref:server:sdk:sdk-doctor.adoc[SDK doctor]
247243

248244
| Couchbase Lite Java Android
249245
| xref:couchbase-lite:android:quickstart.adoc[Docs]
250-
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-android/[API Reference]
246+
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-android/[API Reference]
251247

252248
| Couchbase Lite C#
253249
| xref:couchbase-lite:csharp:quickstart.adoc[Docs]
254-
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-net[API Reference]
250+
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-net[API Reference]
255251

256252
| Couchbase Lite Java
257253
| xref:couchbase-lite:java:quickstart.adoc[Docs]
258-
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-java/index.html?[API Reference]
254+
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-java/index.html?[API Reference]
259255

260256
| Couchbase Lite Objective-C
261257
| xref:couchbase-lite:objc:quickstart.adoc[Docs]
262-
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-objc[API Reference]
258+
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-objc[API Reference]
263259

264260
| Couchbase Lite Swift
265261
| xref:couchbase-lite:swift:quickstart.adoc[Docs]
266-
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-swift[API Reference]
262+
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-swift[API Reference]
267263

268264
| Couchbase Lite JavaScript
269265
| xref:couchbase-lite::javascript.adoc[Docs]
@@ -297,6 +293,7 @@ xref:server:sdk:sdk-doctor.adoc[SDK doctor]
297293
* xref:spark-connector::getting-started.adoc[Get Started]
298294
* xref:spark-connector::dev-workflow.adoc[Development Workflow]
299295
* xref:spark-connector::java-api.adoc[Java API]
296+
* xref:spark-connector::pyspark.adoc[PySpark]
300297

301298
[.column]
302299
.ODBC and JDBC Drivers

0 commit comments

Comments
 (0)