This repo contains the documentation for the Reactive Streams and Scala variants of the MongoDB Java Driver.
Documentation for the synchronous Java driver is available at https://docs.mongodb.com/drivers/java/sync and the source is available at https://github.com/mongodb/docs-java
<this repo>/reference/config.tomlto point to the new base version<this repo>/landing/data/releases.tomlto link to the docs for the new version- any redirects such as the Java sync docs redirect
After making required changes, submit a pull request. Once your PR is approved and merged, run the publish-docs script with the version:
./publish-docs <version>This will initiate a submodule (if necessary) that tracks the gh-pages branch of the mongo-java-driver. It then builds the documents in a new directory in the submodule that corresponds to the new version name.
For major and minor releases, it is required to build the api docs. This
can be done by navigating to your mongo-java-driver repo (Note: NOT the submodule in this repo) and executing the appropriate gradlew command
after checking out the correct tag. Make sure you installed the Java version specified in the :bson:compileJava task on your machine.
For example, to build the apidocs for the 4.4 release of driver:
git checkout r4.4.0
./gradlew clean docsThen copy the build/docs folder into the apidocs directory. For example,
if the mongo-java-driver repo is on a sibling level with this repo:
cp -a ../mongo-java-driver/build/docs ./mongo-java-driver/<version>/apidocsYour submodule directory should contain a directory structure that resembles the following:
<this repo>/<submodule directory>/<version>/apidocs/{bson,mongodb-driver-core,mongodb-driver-sync,mongodb-driver-legacy, mongodb-driver-reactivestreams/}To publish the documentation, you can execute the following commands in your shell from the docs-java-other repository location:
cd mongo-java-driver
git add .
git commit -m <message>
git rebase -i --root
git push origin gh-pages -f