Add 3.9 release to reference documentation

jyemin · jyemin · commit 61282f4f004a · 2018-10-26T11:25:00.000-04:00
diff --git a/docs/landing/data/releases.toml b/docs/landing/data/releases.toml
@@ -1,8 +1,13 @@
-current = "3.8.2"
+current = "3.9.0"
 
 [[versions]]
-  version = "3.8.2"
+  version = "3.9.0"
   status = "current"
+  docs = "./3.9"
+  api = "./3.9/javadoc"
+
+[[versions]]
+  version = "3.8.2"
   docs = "./3.8"
   api = "./3.8/javadoc"
 
@@ -58,25 +63,16 @@ current = "3.8.2"
 
 [[drivers]]
   name = "mongodb-driver-sync"
-  description = "The synchronous driver, new in 3.7.<br/>For older versions of the driver please use the `mongodb-driver` or `mongo-java-driver`."
-  versions = "3.8.2,3.7.1"
+  description = "The synchronous driver, new in 3.7."
+  versions = "3.9.0,3.8.2,3.7.1"
 
 [[drivers]]
-  name = "mongodb-driver"
-  description = "The synchronous driver plus the legacy driver, new in 3.0.<br/>For older versions of the driver or for OSGi-based applications please use the `mongo-java-driver`."
-  versions = "3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4"
-
-[[drivers]]
-  name = "mongo-java-driver"
-  description = "An uber jar containing the bson library, the core library and the mongodb-driver.<br/>This artifact is a valid OSGi bundle."
-  versions = "3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4,2.14.2,2.13.3"
+  name = "mongodb-driver-legacy"
+  description = "The legacy API for the synchronous driver.<br/>Prefer mongodb-driver-sync for new applications"
+  versions = "3.9.0"
 
 [[drivers]]
   name = "mongodb-driver-async"
-  description = "The new asynchronous driver, new in 3.0"
-  versions = "3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4"
+  description = "The callback-based asynchronous driver.<br/>Prefer the Reactive Streams driver for new applications."
+  versions = "3.9.0,3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4"
 
-[[drivers]]
-  name = "mongodb-driver-core"
-  description = "The core library, new in 3.0"
-  versions = "3.8.2,3.7.1,3.6.4,3.5.0,3.4.3,3.3.0,3.2.2,3.1.1,3.0.4"
diff --git a/docs/landing/static/versions.json b/docs/landing/static/versions.json
@@ -1 +1,14 @@
-[{"version": "3.8"}, {"version": "3.7"}, {"version": "3.6"}, {"version": "3.5"}, {"version": "3.4"}, {"version": "3.3"}, {"version": "3.2"}, {"version": "3 .1"}, {"version": "3 .0"}, {"version": "2.13"}, {"version": "2.14"}]
+[
+  {"version": "3.9"},
+  {"version": "3.8"},
+  {"version": "3.7"},
+  {"version": "3.6"},
+  {"version": "3.5"},
+  {"version": "3.4"},
+  {"version": "3.3"},
+  {"version": "3.2"},
+  {"version": "3.1"},
+  {"version": "3.0"},
+  {"version": "2.14"},
+  {"version": "2.13"}
+]
diff --git a/docs/reference/config.toml b/docs/reference/config.toml
@@ -1,4 +1,4 @@
-baseURL = "/mongo-java-driver/3.8"
+baseURL = "/mongo-java-driver/3.9"
 languageCode = "en-us"
 title = "MongoDB Java Driver"
 theme = "mongodb"
diff --git a/docs/reference/content/bson/installation-guide.md b/docs/reference/content/bson/installation-guide.md
@@ -22,4 +22,4 @@ This library comprehensively supports [BSON](http://www.bsonspec.org),
 the data storage and network transfer format that MongoDB uses for "documents".
 BSON is short for Binary [JSON](http://json.org/), is a binary-encoded serialization of JSON-like documents.
 
-{{< install artifactId="bson" version="3.8.2" >}}
+{{< install artifactId="bson" version="3.9.0" >}}
diff --git a/docs/reference/content/driver-async/getting-started/installation.md b/docs/reference/content/driver-async/getting-started/installation.md
@@ -23,4 +23,4 @@ The MongoDB Async Driver requires either [Netty](http://netty.io/) or Java 7.
 
 The MongoDB Async Driver provides asynchronous API that can leverage either Netty or Java 7's AsynchronousSocketChannel for fast and non-blocking I/O.
 
-{{< install artifactId="mongodb-driver-async" version="3.8.2" dependencies="true">}}
+{{< install artifactId="mongodb-driver-async" version="3.9.0" dependencies="true">}}
diff --git a/docs/reference/content/driver-async/index.md b/docs/reference/content/driver-async/index.md
@@ -9,21 +9,16 @@ title = "MongoDB Async Driver"
 
 ## MongoDB Async Java Driver Documentation
 
-The following guide provides information on using the callback-based MongoDB Async Java Driver 3.8.
+The following guide provides information on using the callback-based MongoDB Async Java Driver 3.9.
 
 {{% note %}}
-There are two higher level MongoDB Asynchronous Java Drivers available, that users may find easier to work with due to their friendlier APIs:
-
-* [MongoDB RxJava Driver](http://mongodb.github.io/mongo-java-driver-rx/) An RxJava implementation of the MongoDB Driver.
-* [MongoDB Reactive Streams Java Driver](http://mongodb.github.io/mongo-java-driver-reactivestreams/) A Reactive Streams implementation for the JVM.
+The callback-based Async Java Driver has been deprecated in favor of the 
+[MongoDB Reactive Streams Java Driver](http://mongodb.github.io/mongo-java-driver-reactivestreams/).
 {{% /note %}}
 
-### What's New in 3.8
-
-The [What's New]({{< relref "whats-new.md" >}}) guide explains the major new features of the driver.
+### What's New in 3.9
 
-If you are upgrading from the 2.x series of the driver, consult the [Upgrading]({{< relref "upgrading.md" >}}) documentation for
-information on breaking changes.
+The callback-based MongoDB Async Java driver has been deprecated in the 3.9 release.  
 
 ## Getting Started
 
diff --git a/docs/reference/content/driver/getting-started/installation.md b/docs/reference/content/driver/getting-started/installation.md
@@ -31,7 +31,20 @@ The `mongodb-driver-sync` artifact is a valid OSGi bundle whose symbolic name is
 
 {{% /note %}}
 
-{{< install artifactId="mongodb-driver-sync" version="3.8.2" dependencies="true">}}
+{{< install artifactId="mongodb-driver-sync" version="3.9.0" dependencies="true">}}
+
+## MongoDB Driver Legacy 
+
+The MongoDB Legacy driver `mongodb-driver-legacy` is the legacy synchronous Java driver whose entry point is `com.mongodb.MongoClient` 
+and central classes include `com.mongodb.DB`, `com.mongodb.DBCollection`, and `com.mongodb.DBCursor`.
+
+{{% note class="important" %}}
+
+While not deprecated, we recommend that new applications depend on the `mongodb-driver-sync` module.
+
+{{% /note %}}
+
+{{< install artifactId="mongodb-driver-legacy" version="3.9.0" dependencies="true">}}
 
 ## MongoDB Driver  
 
@@ -44,9 +57,11 @@ For OSGi-based applications, use the [mongodb-driver-sync](#mongodb-driver-sync)
 
 It is also *not* a Java 9 module.
 
+This module is deprecated and will no longer be published in the next major release of the driver (4.0).
+
 {{% /note %}}
 
-{{< install artifactId="mongodb-driver" version="3.8.2" dependencies="true">}}
+{{< install artifactId="mongodb-driver" version="3.9.0" dependencies="true">}}
 
 
 ## Uber Jar (Legacy)
@@ -59,6 +74,11 @@ jar is still available.  The uber jar contains: the BSON library, the core libra
 This is a Java 9-compliant module with an Automatic-Module-Name of `org.mongodb.driver.sync.client`.
 
 The `mongo-java-driver` artifact is a valid OSGi bundle whose symbolic name is `org.mongodb.mongo-java-driver`.
+
+{{% note class="important" %}}
+
+This module is deprecated and will no longer be published in the next major release of the driver (4.0).
+
 {{% /note %}}
 
-{{< install artifactId="mongo-java-driver" version="3.8.2">}}
+{{< install artifactId="mongo-java-driver" version="3.9.0">}}
diff --git a/docs/reference/content/driver/index.md b/docs/reference/content/driver/index.md
@@ -7,12 +7,12 @@ title = "MongoDB Driver"
   pre = "<i class='fa fa-arrows-h'></i>"
 +++
 
-## MongoDB Driver 3.8 Documentation
+## MongoDB Driver 3.9 Documentation
 
 The following guide provides information on using the synchronous
-MongoDB Java Driver 3.8.
+MongoDB Java Driver 3.9.
 
-### What's New in 3.8
+### What's New in 3.9
 
 The [What's New]({{< relref "whats-new.md" >}}) guide explains
 the major new features of the driver.
diff --git a/docs/reference/content/driver/tutorials/jndi.md b/docs/reference/content/driver/tutorials/jndi.md
@@ -28,7 +28,7 @@ The configuration of the `MongoClientFactory` differs depending on the applicati
 
         <module xmlns="urn:jboss:module:1.3" name="org.mongodb">
            <resources>
-               <resource-root path="mongo-java-driver-3.8.2.jar"/>
+               <resource-root path="mongo-java-driver-3.9.0.jar"/>
            </resources>
            <dependencies>
                <module name="javax.api"/>
diff --git a/docs/reference/content/index.md b/docs/reference/content/index.md
@@ -6,12 +6,12 @@ type = "index"
 
 ## MongoDB Java Driver Documentation
 
-Welcome to the MongoDB Java driver documentation hub for the 3.8 driver release.
+Welcome to the MongoDB Java driver documentation hub for the 3.9 driver release.
 
 
-### What's New in 3.8
+### What's New in 3.9
 
-For key new features of 3.8, see [What's New]({{< relref "whats-new.md" >}}).
+For key new features of 3.9, see [What's New]({{< relref "whats-new.md" >}}).
 
 ### Upgrade
 
diff --git a/docs/reference/content/upgrading.md b/docs/reference/content/upgrading.md
@@ -2,45 +2,54 @@
 date = "2015-03-19T12:53:39-04:00"
 title = "Upgrade Considerations"
 [menu.main]
-  identifier = "Upgrading to 3.8"
+  identifier = "Upgrading to 3.9"
   weight = 80
   pre = "<i class='fa fa-level-up'></i>"
 +++
 
-## Upgrading from 3.7.x
+## Upgrading from 3.8.x
 
-The 3.8 driver introduces a small but significant breaking change to the existing API for any application that already depends on session
-support (introduced in the 3.6 release to support causal consistency): the type of ClientSession changes from
-`com.mongodb.session.ClientSession` to `com.mongodb.client.ClientSession`.  This is both source and binary incompatible with the 3.7
-release.  This change was required in order to introduce support in the driver for transactions that works in both the synchronous and the
-asynchronous drivers.
+Numerous classes and methods have been deprecated in the 3.9 release in preparation for a major 4.0 release, in which all deprecated
+API elements except those documented as "not currently scheduled for removal" will be removed. Currently the only API elements _not_ 
+scheduled for removal are:
 
-In addition, the default `authSource` value for connection strings with an `authMechanism` of PLAIN has changed from `admin` to `$external`.
-Users wishing to continue to use PLAIN authentication with the `admin` database should declare `authSource=admin` on the connection string.
+* [`Mongo.getDB`]({{<apiref "com/mongodb/Mongo.html#getDB-java.lang.String-">}})
+* [`JsonMode.STRICT`]({{<apiref "org/bson/json/JsonMode.html#STRICT">}}) 
 
-Otherwise, the 3.8 release is binary and source compatible with the 3.7 release, except for methods that have been added to interfaces that
+To prepare for the 4.0 release, please compile with deprecation warnings enabled and replace all usage of deprecated API elements with their
+recommended replacements.
+
+Also, note that the 3.10 release (which will include support for MongoDB 4.2) will be the last release that is compatible with *Java 6
+or Java 7*.  The 4.0 Java driver will require a minimum of Java 8. The 3.10 release will also be the last non-patch release in the 3.x 
+line. In particular, support for MongoDB 4.4 will only be made available via a 4.x driver release.
+
+The 3.9 release is binary and source compatible with the 3.8 release, except for methods that have been added to interfaces that
 have been marked as unstable, and changes to classes or interfaces that have been marked as internal or annotated as Beta.
 
 ## Upgrading from 2.x
 
 See the Upgrade guide in the 3.0 driver reference documentation for breaking changes in 3.0.
 
-### System Requirements
+## System Requirements
 
-The minimum JVM is now Java 6: however, specific features require Java 7:
+The minimum JVM is Java 6. However, specific features require more recent versions:
 
-- SSL support requires Java 7 in order to perform host name verification, which is enabled by default.  See
+- [Atlas M0 (Free Tier)](https://docs.atlas.mongodb.com/getting-started/) support requires Java 8 or greater due to 
+its reliance on TLS Server Name Indication (SNI).
+- SSL support requires Java 7 or greater in order to perform host name verification, which is enabled by default.  See
 [SSL]({{< relref "driver/tutorials/ssl.md" >}}) for details on how to disable host name verification.
 - The asynchronous API requires Java 7, as by default it relies on
 [`AsynchronousSocketChannel`](http://docs.oracle.com/javase/7/docs/api/java/nio/channels/AsynchronousSocketChannel.html) for
-its implementation.  See [Async]({{< ref "driver-async/index.md" >}}) for details on configuring the driver to use [Netty](http://netty.io/) instead.
+its implementation.  See [Async]({{< ref "driver-async/index.md" >}}) for details on configuring the driver to use 
+[Netty](http://netty.io/) instead.
 
 ## Compatibility
 
 The following table specifies the compatibility of the MongoDB Java driver for use with a specific version of MongoDB.
 
 |Java Driver Version|MongoDB 2.6|MongoDB 3.0 |MongoDB 3.2|MongoDB 3.4|MongoDB 3.6|MongoDB 4.0|
 |-------------------|-----------|------------|-----------|-----------|-----------|-----------|
+|Version 3.9        |  ✓  |  ✓  |  ✓  |  ✓  |  ✓  |  ✓  |
 |Version 3.8        |  ✓  |  ✓  |  ✓  |  ✓  |  ✓  |  ✓  |
 |Version 3.7        |  ✓  |  ✓  |  ✓  |  ✓  |  ✓  |     |
 |Version 3.6        |  ✓  |  ✓  |  ✓  |  ✓  |  ✓  |     |
@@ -50,17 +59,3 @@ The following table specifies the compatibility of the MongoDB Java driver for u
 |Version 3.2        |  ✓  |  ✓  |  ✓  |     |     |     |
 |Version 3.1        |  ✓  |  ✓  |     |     |     |     |
 |Version 3.0        |  ✓  |  ✓  |     |     |     |     |
-
-The following table specifies the compatibility of the MongoDB Java driver for use with a specific version of Java.
-
-|Java Driver Version|Java 5 | Java 6 | Java 7 | Java 8 |
-|-------------------|-------|--------|--------|--------|
-|Version 3.8        |     | ✓ | ✓ | ✓ |
-|Version 3.7        |     | ✓ | ✓ | ✓ |
-|Version 3.6        |     | ✓ | ✓ | ✓ |
-|Version 3.5        |     | ✓ | ✓ | ✓ |
-|Version 3.4        |     | ✓ | ✓ | ✓ |
-|Version 3.3        |     | ✓ | ✓ | ✓ |
-|Version 3.2        |     | ✓ | ✓ | ✓ |
-|Version 3.1        |     | ✓ | ✓ | ✓ |
-|Version 3.0        |     | ✓ | ✓ | ✓ |
diff --git a/docs/reference/content/whats-new.md b/docs/reference/content/whats-new.md
@@ -7,6 +7,20 @@ title = "What's New"
   pre = "<i class='fa fa-level-up'></i>"
 +++
 
+## What's new in 3.9
+
+Key new features of the 3.9 Java driver release:
+
+### Android support
+
+The `mongodb-driver-embedded-android` module supports interaction with a MongoDB server running on an Android device.
+See [MongoDB Mobile](https://www.mongodb.com/products/mobile) for more details.
+
+### Deprecations
+
+Numerous classes and methods have been deprecated in the 3.9 release in preparation for a major 4.0 release.  See the 
+[Upgrading Guide]({{<ref "upgrading.md">}}) for more information.
+
 ## What's New in 3.8
 
 Key new features of the 3.8 Java driver release:
diff --git a/docs/reference/data/mongodb.toml b/docs/reference/data/mongodb.toml
@@ -1,6 +1,6 @@
 # Update versions in config.toml as well
 githubRepo = "mongo-java-driver"
 githubBranch = "master"
-currentVersion = "3.8"
+currentVersion = "3.9"
 highlightTheme = "idea.css"
 apiUrl = "/javadoc"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-baseURL = "/mongo-java-driver/3.8"`
	`1`	`+baseURL = "/mongo-java-driver/3.9"`
`2`	`2`	`languageCode = "en-us"`
`3`	`3`	`title = "MongoDB Java Driver"`
`4`	`4`	`theme = "mongodb"`
Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,4 @@ The MongoDB Async Driver requires either [Netty](http://netty.io/) or Java 7.`
`23`	`23`
`24`	`24`	`The MongoDB Async Driver provides asynchronous API that can leverage either Netty or Java 7's AsynchronousSocketChannel for fast and non-blocking I/O.`
`25`	`25`
`26`		`-{{< install artifactId="mongodb-driver-async" version="3.8.2" dependencies="true">}}`
	`26`	`+{{< install artifactId="mongodb-driver-async" version="3.9.0" dependencies="true">}}`