[JAVA-3820] Java docs apiref link leads to wrong url -> 404 page Created: 29/Jul/20  Updated: 24/Sep/20  Resolved: 24/Sep/20

Status: Closed
Project: Java Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Christopher Cho Assignee: Ross Lawley
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to JAVA-3844 Run a link checker over the driver docs Closed

 Description   

Description

Not certain whether other API links are broken at the moment, but I noticed that at least one link generated with "apiref" is leading to a 404 page because it redirects to "mongodb-driver-core" as part of the expansion rather than "mongodb-driver-sync".

E.g.

On http://mongodb.github.io/mongo-java-driver/4.0/driver/tutorials/authentication/ 

the "MongoClient" API docs link goes to:

http://mongodb.github.io/mongo-java-driver/4.0/apidocs/mongodb-driver-core/com/mongodb/MongoClient.html

While the actual documentation is located at:

https://mongodb.github.io/mongo-java-driver/4.0/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html

 

I checked another instance of apiref in the docs, and it correctly expanded to "mongodb-driver-sync". 

E.g.

On http://mongodb.github.io/mongo-java-driver/4.0/driver/tutorials/perform-read-operations/

the "find()" API docs link correctly goes to 

http://mongodb.github.io/mongo-java-driver/4.0/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#find()

 

jeff.yemin have you seen this and do you know how to resolve it?

 

 

 

 

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 24/Sep/20 ]

Author:

{'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}

Message: Fix MongoClient api docs link

JAVA-3820
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/2ad11ec8a2341593938f375676d84dced88be472

Comment by Githook User [ 24/Sep/20 ]

Author:

{'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}

Message: Fix MongoClient api docs link

JAVA-3820
Branch: 4.1.x
https://github.com/mongodb/mongo-java-driver/commit/f2c61dbffcd38b5759a14ec6b6dd245cb5d6c458

Comment by Githook User [ 24/Sep/20 ]

Author:

{'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}

Message: Fix MongoClient api docs link

JAVA-3820
Branch: 4.0.x
https://github.com/mongodb/mongo-java-driver/commit/f4622c0d115cbbe44c8de5d630cf730b6ea25610

Comment by Jeffrey Yemin [ 29/Jul/20 ]

No, I was not aware. Yes, it's fixable.

Generated at Thu Feb 08 09:00:31 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.