DOC-12917 signposts from Java SDK to Quarkus

couchbase · Jan 21, 2025 · 9483813 · 9483813
1 parent 778dc2c
commit 9483813
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 1 deletion.
diff --git a/modules/hello-world/pages/overview.adoc b/modules/hello-world/pages/overview.adoc
@@ -80,7 +80,17 @@ Install the SDK, and explore in the way that works best for you.
 </dependencies>
 ----
 
-The links below will take you where you want to go -- as will the navigation on the left-hand side of this page.
+The Couchbase Java SDK integrates into the Java ecosystem through a number of extensions and connectors, including:
+
+* https://spring.io/projects/spring-data-couchbase[Spring Data]
+* https://blog.couchbase.com/couchbase-spring-boot-spring-data/[Spring Boot]
+* xref:quarkus-extension:ROOT:overview.adoc[Couchbase Quarkus Java Extension]
+* xref:3.5@spark-connector:ROOT:java-api.adoc[Apache Spark Connector]
+
+
+== Exploring the Java SDK
+
+The links in the sections below will take you where you want to go -- as will the navigation on the left-hand side of this page.
 But if you don't know exactly where you need to go, try one of the following:
 
 * Our xref:hello-world:start-using-sdk.adoc[Quickstart Guide] introduces the SDK with a quick install, and CRUD examples against the Data Service.
@@ -185,6 +195,7 @@ Useful resources to help support your development experience with Couchbase and
 // * https://docs-archive.couchbase.com/home/index.html[Older Versions Archive]
 // ** xref:project-docs:migrating-sdk-code-to-3.n.adoc[]
 * xref:project-docs:third-party-integrations.adoc[]
+* xref:quarkus-extension:ROOT:overview.adoc[Couchbase Quarkus Java Extension]
 * xref:project-docs:sdk-full-installation.adoc[]
 
 ++++

diff --git a/modules/hello-world/pages/start-using-sdk.adoc b/modules/hello-world/pages/start-using-sdk.adoc
@@ -234,6 +234,21 @@ Cluster cluster = Cluster.connect(
 
 Read more on the xref:howtos:managing-connections.adoc#cloud-native-gateway[Connections] page.
 --
+
+Quarkus::
++
+--
+Our  xref:quarkus-extension:ROOT:overview.adoc[Couchbase Quarkus Java Extension docs] cover installing and connecting with the Quarkus extension in detail,
+but if you already have Quarkus installed and a project ready (with `quarkus-couchbase` in your `pom.xml` or `build.gradle`),
+then your `src/main/resources/application.properties` file needs to contain:
+
+[source,properties]
+----
+quarkus.couchbase.connection-string=localhost
+quarkus.couchbase.username=username
+quarkus.couchbase.password=password
+----
+--
 ====
 
 

diff --git a/modules/howtos/pages/managing-connections.adoc b/modules/howtos/pages/managing-connections.adoc
@@ -240,6 +240,21 @@ E.....@.@.............+....Z.'yZ..#........
 
 
 
+== Quarkus Java Extension
+
+
+Our  xref:quarkus-extension:ROOT:overview.adoc[Couchbase Quarkus Java Extension docs] cover installing and connecting with the Quarkus extension in detail,
+but if you already have Quarkus installed and a project ready (with `quarkus-couchbase` in your `pom.xml` or `build.gradle`),
+then your `src/main/resources/application.properties` file needs to contain:
+
+[source,properties]
+----
+quarkus.couchbase.connection-string=localhost
+quarkus.couchbase.username=username
+quarkus.couchbase.password=password
+----
+
+
 
 == Cloud Native Gateway
 

diff --git a/modules/project-docs/pages/compatibility.adoc b/modules/project-docs/pages/compatibility.adoc
@@ -227,6 +227,11 @@ Please make sure that you are using a supported version of the Couchbase Java SD
 Using the latest Spring Data Couchbase should ensure that this is so.
 
 
+=== Quarkus Java Compatibility
+
+See the xref:quarkus-extension:ROOT:overview.adoc[Couchbase Quarkus Java Extension docs] for details of using Quarkus, and the compatibility with Quarkus, GraalVM, and the Couchbase Java SDK.
+
+
 === API Version
 
 include::{version-common}@sdk:shared:partial$api-version.adoc[tag=api-version]

diff --git a/modules/project-docs/pages/third-party-integrations.adoc b/modules/project-docs/pages/third-party-integrations.adoc
@@ -15,6 +15,8 @@ include::{version-common}@sdk:shared:partial$integrations.adoc[tag=intro]
 include::{version-common}@sdk:shared:partial$integrations.adoc[tag=official]
 
 The Couchbase Java SDK is a first class citizen in the https://spring.io/projects/spring-data-couchbase[Spring Data] world, and there are many examples of using the SDK with https://blog.couchbase.com/couchbase-spring-boot-spring-data/[Spring Boot] and Spring Data (and Spring Data JPA).
+Quarkus integration is covererd in the xref:quarkus-extension:ROOT:overview.adoc[Couchbase Quarkus Java Extension docs].
+
 
 Couchbase also supports integrating with xref:3.5@spark-connector:ROOT:java-api.adoc[Spark].