Update documentation for Java 17 requirement

aehrc · May 21, 2024 · 5aa93dd · 5aa93dd
1 parent d1c60b6
commit 5aa93dd
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/lib/python/README.md b/lib/python/README.md
@@ -271,11 +271,11 @@ Maven package. Once the cluster is restarted, the libraries should be available
 for import and use within all notebooks.
 
 By default, Databricks uses Java 8 within its clusters, while Pathling requires
-Java 11. To enable Java 11 support within your cluster, navigate to __Advanced
+Java 17. To enable Java 17 support within your cluster, navigate to __Advanced
 Options > Spark > Environment Variables__ and add the following:
 
 ```bash
-JNAME=zulu11-ca-amd64
+JNAME=zulu17-ca-amd64
 ```
 
 See the Databricks documentation on

diff --git a/site/docs/libraries/installation/index.md b/site/docs/libraries/installation/index.md
@@ -19,7 +19,7 @@ pip install pathling
 
 ### R
 
-Prerequisites: 
+Prerequisites:
 
 - R >= 3.5.0 (tested with 4.3.1)
 
@@ -48,6 +48,7 @@ To add the Pathling library to your project, add the following to
 your `pom.xml`:
 
 ```xml
+
 <dependency>
     <groupId>au.csiro.pathling</groupId>
     <artifactId>library-runtime</artifactId>
@@ -57,11 +58,11 @@ your `pom.xml`:
 
 ### Java Virtual Machine
 
-All variants of the Pathling library require version 11 of a Java Virtual
-Machine (JVM) to be installed. We recommend
-using Azul OpenJDK, you can download installers for all major operating systems
-at the [Azul OpenJDK](https://www.azul.com/downloads/?version=java-11-lts) web
-site.
+All variants of the Pathling library require version 17 of a Java Virtual
+Machine (JVM) to be installed. We recommend using Azul OpenJDK, you can download
+installers for all major operating systems at
+the [Azul OpenJDK](https://www.azul.com/downloads/?version=java-17-lts#zulu)
+website.
 
 Ensure that the `JAVA_HOME` environment variable is set to the location of the
-installation of Java 11.
+installation of Java 17.
diff --git a/site/docs/libraries/installation/windows.md b/site/docs/libraries/installation/windows.md
@@ -36,7 +36,7 @@ hadoop
 If this executes successfully, finding the Hadoop executable and printing the 
 help text, then the variables have been set correctly.
 
-As with other operating systems, you also need to have Java 11 installed and
+As with other operating systems, you also need to have Java 17 installed and
 the `JAVA_HOME` environment variable set to its installation location. We
 recommend
-the [Azul Zulu installer for Windows](https://www.azul.com/downloads/?version=java-11-lts&os=windows&package=jdk#zulu).
+the [Azul Zulu installer for Windows](https://www.azul.com/downloads/?version=java-17-lts&os=windows&package=jdk#zulu).