Skip to content

Update documentation links #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Mar 29, 2022
Merged

Update documentation links #905

merged 4 commits into from
Mar 29, 2022

Conversation

jyemin
Copy link
Collaborator

@jyemin jyemin commented Mar 29, 2022

Also fixed some broken links and a few others that I noticed were redirecting

@jyemin
Update documentation links
dbe4338 
* Change docs.mongodb.com to www.mongodb.com/docs
* Change docs.mongodb.org to www.mongodb.com/docs
* Change www.mongodb.org to www.mongodb.com
* Change http to https
@jyemin jyemin requested a review from stIncMale March 29, 2022 12:54
@jyemin jyemin self-assigned this Mar 29, 2022
@stIncMale stIncMale mentioned this pull request Mar 29, 2022
Closed
@jyemin jyemin requested a review from ccho-mongodb March 29, 2022 16:18
ccho-mongodb
ccho-mongodb approved these changes Mar 29, 2022
View reviewed changes
Copy link

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Added some link updates that reflect some changes in the manual that I noticed.

bson/src/main/org/bson/json/JsonReader.java
@@ -53,12 +53,12 @@
* <ul>
* <li><em>Strict mode</em> that conforms to the <a href="http://www.json.org/">JSON RFC specifications.</a></li>
* <li><em>JavaScript mode</em> that that most JavaScript interpreters can process</li>
* <li><em>Shell mode</em> that the <a href="http://docs.mongodb.org/manual/reference/mongo/#mongo">mongo</a> shell can process.
* <li><em>Shell mode</em> that the <a href="https://www.mongodb.com/docs/manual/reference/mongo/#mongo">mongo</a> shell can process.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No change necessary, but the "#mongo" anchor at the end of this URL doesn't exist at the moment, so you can remove that part of it.

driver-scala/src/main/scala/org/mongodb/scala/MapReduceObservable.scala
@@ -52,7 +52,7 @@ case class MapReduceObservable[TResult](wrapped: MapReducePublisher[TResult]) ex
/**
* Sets the JavaScript function that follows the reduce method and modifies the output.
*
* [[http://docs.mongodb.org/manual/reference/command/mapReduce#mapreduce-finalize-cmd Requirements for the finalize Function]]
* [[https://www.mongodb.com/docs/manual/reference/command/mapReduce#mapreduce-finalize-cmd Requirements for the finalize Function]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the current anchor doesn't exist. I think this is the new anchor target you might have intended to link to:
https://www.mongodb.com/docs/manual/reference/command/mapReduce/#requirements-for-the-finalize-function

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -29,23 +29,23 @@ object MongoCredential {
/**
* The GSSAPI mechanism. See the <a href="http://tools.ietf.org/html/rfc4752">RFC</a>.
*
@see [[http://docs.mongodb.org/manual/core/authentication/#kerberos-authentication GSSAPI]]
@see [[https://www.mongodb.com/docs/manual/core/authentication/#kerberos-authentication GSSAPI]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this refers to an old target.
Instead, maybe the link should be:
https://www.mongodb.com/docs/manual/core/kerberos/
or if you want to link directly to GSSAPI through AD auth:
https://www.mongodb.com/docs/manual/tutorial/kerberos-auth-activedirectory-authz/

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
* @since 4.0
*/
val GSSAPI_MECHANISM: String = JMongoCredential.GSSAPI_MECHANISM

/**
* The PLAIN mechanism. See the <a href="http://www.ietf.org/rfc/rfc4616.txt">RFC</a>.
*
@see [[http://docs.mongodb.org/manual/core/authentication/#ldap-proxy-authority-authentication PLAIN]]
@see [[https://www.mongodb.com/docs/manual/core/authentication/#ldap-proxy-authority-authentication PLAIN]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this refers to an old target.
New link suggestion: https://www.mongodb.com/docs/manual/core/security-ldap/

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -54,7 +54,7 @@ object MongoCredential {
* The SCRAM-SHA-1 Mechanism.
*
* @note Requires MongoDB 3.0 or greater
@see [[http://docs.mongodb.org/manual/core/authentication/#authentication-scram-sha-1 SCRAM-SHA-1]]
@see [[https://www.mongodb.com/docs/manual/core/authentication/#authentication-scram-sha-1 SCRAM-SHA-1]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this links to an old target.
New link suggestion: https://www.mongodb.com/docs/manual/core/security-scram/#std-label-authentication-scram-sha-1

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -179,7 +179,7 @@ object MongoCredential {
* acts as the userName.
*
* @return the credential
* @see [[http://docs.mongodb.org/manual/core/authentication/#x-509-certificate-authentication X-509]]
* @see [[https://www.mongodb.com/docs/manual/core/authentication/#x-509-certificate-authentication X-509]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this links to an old target.
New link suggestion: https://www.mongodb.com/docs/manual/core/security-x.509/

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -64,7 +64,7 @@ object MongoCredential {
*
* @since 3.8
* @note Requires MongoDB 4.0 or greater
@see [[http://docs.mongodb.org/manual/core/authentication/#authentication-scram-sha-256 SCRAM-SHA-256]]
@see [[https://www.mongodb.com/docs/manual/core/authentication/#authentication-scram-sha-256 SCRAM-SHA-256]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this links to an old target.
New link suggestion: https://www.mongodb.com/docs/manual/core/security-scram/#std-label-authentication-scram-sha-256

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -169,7 +169,7 @@ object MongoCredential {
*
* @param userName the user name
* @return the credential
* @see [[http://docs.mongodb.org/manual/core/authentication/#x-509-certificate-authentication X-509]]
* @see [[https://www.mongodb.com/docs/manual/core/authentication/#x-509-certificate-authentication X-509]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this links to an old target.
New link suggestion: https://www.mongodb.com/docs/manual/core/security-x.509/

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -204,7 +204,7 @@ object MongoCredential {
*
* @param userName the non-null user name
* @return the credential
* @see [[http://docs.mongodb.org/manual/core/authentication/#kerberos-authentication GSSAPI]]
* @see [[https://www.mongodb.com/docs/manual/core/authentication/#kerberos-authentication GSSAPI]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this refers to an old target.
Instead, maybe the link should be:
https://www.mongodb.com/docs/manual/core/kerberos/
or if you want to link directly to GSSAPI through AD auth:
https://www.mongodb.com/docs/manual/tutorial/kerberos-auth-activedirectory-authz/

driver-scala/src/main/scala/org/mongodb/scala/MongoCredential.scala
@@ -192,7 +192,7 @@ object MongoCredential {
* @param source the source where the user is defined. This can be either `\$external` or the name of a database.
* @param password the non-null user password
* @return the credential
* @see [[http://docs.mongodb.org/manual/core/authentication/#ldap-proxy-authority-authentication PLAIN]]
* @see [[https://www.mongodb.com/docs/manual/core/authentication/#ldap-proxy-authority-authentication PLAIN]]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this refers to an old target.
New link suggestion: https://www.mongodb.com/docs/manual/core/security-ldap/

@jyemin jyemin merged commit eb35443 into mongodb:master Mar 29, 2022
@jyemin jyemin deleted the updateDocLinks branch March 29, 2022 17:48
@jyemin
Copy link
Collaborator Author

jyemin commented Mar 29, 2022

@ccho-mongodb let's fix all the links in a separate PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stIncMale stIncMale stIncMale approved these changes

+1 more reviewer

@ccho-mongodb ccho-mongodb ccho-mongodb approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@jyemin jyemin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jyemin @stIncMale @ccho-mongodb