Skip to content

Commit 1209293

Browse files
committed
docs: add java version compatibility
1 parent cf19517 commit 1209293

File tree

4 files changed

+21
-9
lines changed

4 files changed

+21
-9
lines changed

docs/01-get-started/02-java-hello-world.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ You can also review [Java-Client](/docs/java-client) and [java-docs](https://www
1414

1515
## Include Cadence Java Client Dependency
1616

17-
Go to the [Maven Repository Uber Cadence Java Client Page](https://mvnrepository.com/artifact/com.uber.cadence/cadence-client)
18-
and find the latest version of the library. Include it as a dependency into your Java project. For example if you
19-
are using Gradle the dependency looks like:
20-
```bash
17+
Custom snippets for including the Cadence Java Client can be found in the [cadence-client](https://central.sonatype.com/artifact/com.uber.cadence/cadence-client) page on Maven Central. Latest version is available in the [Cadence Java Client Releases](/docs/releases/cadence-java-client) page
18+
19+
Include the cadence-client as a dependency into your Java project. For example if you
20+
are using Gradle, the dependency looks like:
21+
```gradle
2122
implementation group: 'com.uber.cadence', name: 'cadence-client', version: '<latest_version>'
2223
```
2324
Also add the following dependencies that cadence-client relies on:
24-
```bash
25+
```gradle
2526
implementation group: 'commons-configuration', name: 'commons-configuration', version: '1.9'
2627
implementation group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.3'
2728
```

docs/09-releases/go-client.mdx renamed to docs/09-releases/cadence-go-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Cadence Go Client Releases
44
description: Release Notes
5-
permalink: /docs/releases/go-client
5+
permalink: /docs/releases/cadence-go-client
66
---
77

88
# Cadence Go Client

docs/09-releases/java-client.mdx renamed to docs/09-releases/cadence-java-client.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Cadence Java Client Releases
44
description: Release Notes
5-
permalink: /docs/releases/java-client
5+
permalink: /docs/releases/cadence-java-client
66
---
77

88
# Cadence Java Client
@@ -20,6 +20,17 @@ Cadence follows [semantic versioning](https://semver.org/spec/v2.0.0.html) and y
2020
2121
:::
2222

23+
:::info[Java Compatibility]
24+
25+
Java versions 21, 17 and 11 are supported at this time.
26+
27+
Due to backward compatibility, Java versions 17+ require the following JVM flag
28+
```
29+
--add-opens java.base/java.lang=ALL-UNNAMED
30+
```
31+
32+
:::
33+
2334
## Major Releases
2435
<ListReleases releases={releases}></ListReleases>
2536

sidebars.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,8 @@ const sidebars: SidebarsConfig = {
148148
type: 'category',
149149
items: [
150150
{ type: 'doc', 'id': 'releases/cadence', label: 'Cadence Service' },
151-
{ type: 'doc', 'id': 'releases/go-client', label: 'Cadence Go Client' },
152-
{ type: 'doc', 'id': 'releases/java-client', label: 'Cadence Java Client' },
151+
{ type: 'doc', 'id': 'releases/cadence-go-client', label: 'Cadence Go Client' },
152+
{ type: 'doc', 'id': 'releases/cadence-java-client', label: 'Cadence Java Client' },
153153
],
154154
},
155155
{

0 commit comments

Comments
 (0)