-
Type: Improvement
-
Resolution: Fixed
-
Priority: Major - P3
-
Affects Version/s: None
-
Component/s: Build, Documentation
-
None
When using the Java driver, you need to decide which one of the 3 different ones you will use. Then you select the one you want from the drop down menu at:
https://mongodb.github.io/mongo-java-driver/
After installing the driver, if you need information about the classes and search for a given class in the Java docs at:
http://mongodb.github.io/mongo-java-driver
You see only one set of docs for the 3 products.
Taking a "MongoClient" object for example; in one driver it is an interface and a class in another. The listed methods are not available in all drivers, so it is confusing if you use the Javadocs to see what you can do on an object
I think we should have 3 sets of Javadocs, one per downloadable driver.
It could be something like the following:
* http://mongodb.github.io/mongo-java-driver/mongodb-driver-sync/<versions>
* http://mongodb.github.io/mongo-java-driver/mongodb-driver-async/<versions>
* http://mongodb.github.io/mongo-java-driver/mongodb-driver-legacy/<versions>
As a user, I would see the docs that match the product I am using.
- depends on
-
JAVA-1711 Automate publishing to GitHub pages
- Closed