Skip to content

Commit 63f9e36

Browse files
authored
RUST-1252 change docs.mongodb to mongodb.com/docs (mongodb#678)
* change docs.mongodb to mongodb.com/docs * fix slash in links
1 parent 5dcbbab commit 63f9e36

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+164
-164
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ We encourage and would happily accept contributions in the form of GitHub pull r
302302

303303
## Running the tests
304304
### Integration and unit tests
305-
In order to run the tests (which are mostly integration tests), you must have access to a MongoDB deployment. You may specify a [MongoDB connection string](https://docs.mongodb.com/manual/reference/connection-string/) in the `MONGODB_URI` environment variable, and the tests will use it to connect to the deployment. If `MONGODB_URI` is unset, the tests will attempt to connect to a local deployment on port 27017.
305+
In order to run the tests (which are mostly integration tests), you must have access to a MongoDB deployment. You may specify a [MongoDB connection string](https://www.mongodb.com/docs/manual/reference/connection-string/) in the `MONGODB_URI` environment variable, and the tests will use it to connect to the deployment. If `MONGODB_URI` is unset, the tests will attempt to connect to a local deployment on port 27017.
306306

307307
**Note:** The integration tests will clear out the databases/collections they need to use, but they do not clean up after themselves.
308308

benchmarks/src/bench/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ pub async fn drop_database(uri: &str, database: &str) -> Result<()> {
144144
client.database(&database).drop(None).await?;
145145

146146
// in sharded clusters, take additional steps to ensure database is dropped completely.
147-
// see: https://docs.mongodb.com/manual/reference/method/db.dropDatabase/#replica-set-and-sharded-clusters
147+
// see: https://www.mongodb.com/docs/manual/reference/method/db.dropDatabase/#replica-set-and-sharded-clusters
148148
let is_sharded = hello.get_str("msg").ok() == Some("isdbgrid");
149149
if is_sharded {
150150
client.database(&database).drop(None).await?;

src/change_stream/event.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use serde::{Deserialize, Serialize};
1818
/// with instances of `ResumeToken`.
1919
///
2020
/// See the documentation
21-
/// [here](https://docs.mongodb.com/manual/changeStreams/#change-stream-resume-token) for more
21+
/// [here](https://www.mongodb.com/docs/manual/changeStreams/#change-stream-resume-token) for more
2222
/// information on resume tokens.
2323
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
2424
pub struct ResumeToken(pub(crate) RawBson);
@@ -49,19 +49,19 @@ impl ResumeToken {
4949
}
5050

5151
/// A `ChangeStreamEvent` represents a
52-
/// [change event](https://docs.mongodb.com/manual/reference/change-events/) in the associated change stream.
52+
/// [change event](https://www.mongodb.com/docs/manual/reference/change-events/) in the associated change stream.
5353
#[derive(Debug, Serialize, Deserialize, PartialEq)]
5454
#[serde(rename_all = "camelCase")]
5555
#[non_exhaustive]
5656
pub struct ChangeStreamEvent<T> {
5757
/// An opaque token for use when resuming an interrupted `ChangeStream`.
5858
///
5959
/// See the documentation
60-
/// [here](https://docs.mongodb.com/manual/changeStreams/#change-stream-resume-token) for
60+
/// [here](https://www.mongodb.com/docs/manual/changeStreams/#change-stream-resume-token) for
6161
/// more information on resume tokens.
6262
///
6363
/// Also see the documentation on [resuming a change
64-
/// stream](https://docs.mongodb.com/manual/changeStreams/#resume-a-change-stream).
64+
/// stream](https://www.mongodb.com/docs/manual/changeStreams/#resume-a-change-stream).
6565
#[serde(rename = "_id")]
6666
pub id: ResumeToken,
6767

@@ -144,28 +144,28 @@ pub struct TruncatedArray {
144144
#[derive(Debug, Clone, PartialEq, Eq)]
145145
#[non_exhaustive]
146146
pub enum OperationType {
147-
/// See [insert-event](https://docs.mongodb.com/manual/reference/change-events/#insert-event)
147+
/// See [insert-event](https://www.mongodb.com/docs/manual/reference/change-events/#insert-event)
148148
Insert,
149149

150-
/// See [update-event](https://docs.mongodb.com/manual/reference/change-events/#update-event)
150+
/// See [update-event](https://www.mongodb.com/docs/manual/reference/change-events/#update-event)
151151
Update,
152152

153-
/// See [replace-event](https://docs.mongodb.com/manual/reference/change-events/#replace-event)
153+
/// See [replace-event](https://www.mongodb.com/docs/manual/reference/change-events/#replace-event)
154154
Replace,
155155

156-
/// See [delete-event](https://docs.mongodb.com/manual/reference/change-events/#delete-event)
156+
/// See [delete-event](https://www.mongodb.com/docs/manual/reference/change-events/#delete-event)
157157
Delete,
158158

159-
/// See [drop-event](https://docs.mongodb.com/manual/reference/change-events/#drop-event)
159+
/// See [drop-event](https://www.mongodb.com/docs/manual/reference/change-events/#drop-event)
160160
Drop,
161161

162-
/// See [rename-event](https://docs.mongodb.com/manual/reference/change-events/#rename-event)
162+
/// See [rename-event](https://www.mongodb.com/docs/manual/reference/change-events/#rename-event)
163163
Rename,
164164

165-
/// See [dropdatabase-event](https://docs.mongodb.com/manual/reference/change-events/#dropdatabase-event)
165+
/// See [dropdatabase-event](https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event)
166166
DropDatabase,
167167

168-
/// See [invalidate-event](https://docs.mongodb.com/manual/reference/change-events/#invalidate-event)
168+
/// See [invalidate-event](https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event)
169169
Invalidate,
170170

171171
/// A catch-all for future event types.

src/change_stream/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ use crate::{
7171
/// # }
7272
/// ```
7373
///
74-
/// See the documentation [here](https://docs.mongodb.com/manual/changeStreams) for more
75-
/// details. Also see the documentation on [usage recommendations](https://docs.mongodb.com/manual/administration/change-streams-production-recommendations/).
74+
/// See the documentation [here](https://www.mongodb.com/docs/manual/changeStreams) for more
75+
/// details. Also see the documentation on [usage recommendations](https://www.mongodb.com/docs/manual/administration/change-streams-production-recommendations/).
7676
#[derive(Derivative)]
7777
#[derivative(Debug)]
7878
pub struct ChangeStream<T>
@@ -111,7 +111,7 @@ where
111111
/// change.
112112
///
113113
/// See the documentation
114-
/// [here](https://docs.mongodb.com/manual/changeStreams/#change-stream-resume-token) for more
114+
/// [here](https://www.mongodb.com/docs/manual/changeStreams/#change-stream-resume-token) for more
115115
/// information on change stream resume tokens.
116116
pub fn resume_token(&self) -> Option<ResumeToken> {
117117
self.data.resume_token.clone()

src/change_stream/options.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pub struct ChangeStreamOptions {
3838
/// collection is dropped and recreated or newly renamed, `start_after` should be set instead.
3939
/// `resume_after` and `start_after` cannot be set simultaneously.
4040
///
41-
/// For more information on resuming a change stream see the documentation [here](https://docs.mongodb.com/manual/changeStreams/#change-stream-resume-after)
41+
/// For more information on resuming a change stream see the documentation [here](https://www.mongodb.com/docs/manual/changeStreams/#change-stream-resume-after)
4242
#[builder(default)]
4343
pub resume_after: Option<ResumeToken>,
4444

@@ -54,7 +54,7 @@ pub struct ChangeStreamOptions {
5454
///
5555
/// This feature is only available on MongoDB 4.2+.
5656
///
57-
/// See the documentation [here](https://docs.mongodb.com/master/changeStreams/#change-stream-start-after) for more
57+
/// See the documentation [here](https://www.mongodb.com/docs/master/changeStreams/#change-stream-start-after) for more
5858
/// information.
5959
#[builder(default)]
6060
pub start_after: Option<ResumeToken>,

src/change_stream/session.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ where
5555
/// change.
5656
///
5757
/// See the documentation
58-
/// [here](https://docs.mongodb.com/manual/changeStreams/#change-stream-resume-token) for more
58+
/// [here](https://www.mongodb.com/docs/manual/changeStreams/#change-stream-resume-token) for more
5959
/// information on change stream resume tokens.
6060
pub fn resume_token(&self) -> Option<ResumeToken> {
6161
self.data.resume_token.clone()

src/client/auth/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ pub enum AuthMechanism {
4646

4747
/// The SCRAM-SHA-1 mechanism as defined in [RFC 5802](http://tools.ietf.org/html/rfc5802).
4848
///
49-
/// See the [MongoDB documentation](https://docs.mongodb.com/manual/core/security-scram/) for more information.
49+
/// See the [MongoDB documentation](https://www.mongodb.com/docs/manual/core/security-scram/) for more information.
5050
ScramSha1,
5151

5252
/// The SCRAM-SHA-256 mechanism which extends [RFC 5802](http://tools.ietf.org/html/rfc5802) and is formally defined in [RFC 7677](https://tools.ietf.org/html/rfc7677).
5353
///
54-
/// See the [MongoDB documentation](https://docs.mongodb.com/manual/core/security-scram/) for more information.
54+
/// See the [MongoDB documentation](https://www.mongodb.com/docs/manual/core/security-scram/) for more information.
5555
ScramSha256,
5656

5757
/// The MONGODB-X509 mechanism based on the usage of X.509 certificates to validate a client
5858
/// where the distinguished subject name of the client certificate acts as the username.
5959
///
60-
/// See the [MongoDB documentation](https://docs.mongodb.com/manual/core/security-x.509/) for more information.
60+
/// See the [MongoDB documentation](https://www.mongodb.com/docs/manual/core/security-x.509/) for more information.
6161
MongoDbX509,
6262

6363
/// Kerberos authentication mechanism as defined in [RFC 4752](http://tools.ietf.org/html/rfc4752).
6464
///
65-
/// See the [MongoDB documentation](https://docs.mongodb.com/manual/core/kerberos/) for more information.
65+
/// See the [MongoDB documentation](https://www.mongodb.com/docs/manual/core/kerberos/) for more information.
6666
///
6767
/// Note: This mechanism is not currently supported by this driver but will be in the future.
6868
Gssapi,
@@ -72,7 +72,7 @@ pub enum AuthMechanism {
7272
/// Since the credentials are stored outside of MongoDB, the "$external" database must be used
7373
/// for authentication.
7474
///
75-
/// See the [MongoDB documentation](https://docs.mongodb.com/manual/core/security-ldap/#ldap-proxy-authentication) for more information on LDAP authentication.
75+
/// See the [MongoDB documentation](https://www.mongodb.com/docs/manual/core/security-ldap/#ldap-proxy-authentication) for more information on LDAP authentication.
7676
Plain,
7777

7878
/// MONGODB-AWS authenticates using AWS IAM credentials (an access key ID and a secret access

src/client/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ const DEFAULT_SERVER_SELECTION_TIMEOUT: Duration = Duration::from_secs(30);
8888
/// ## TCP Keepalive
8989
/// TCP keepalive is enabled by default with ``tcp_keepalive_time`` set to 120 seconds. The
9090
/// driver does not set ``tcp_keepalive_intvl``. See the
91-
/// [MongoDB Diagnostics FAQ keepalive section](https://docs.mongodb.com/manual/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments)
91+
/// [MongoDB Diagnostics FAQ keepalive section](https://www.mongodb.com/docs/manual/faq/diagnostics/#does-tcp-keepalive-time-affect-mongodb-deployments)
9292
/// for instructions on setting these values at the system level.
9393
#[derive(Clone, Debug)]
9494
pub struct Client {
@@ -267,7 +267,7 @@ impl Client {
267267
/// "admin" databases. Note that this method (`watch` on a cluster) is only supported in
268268
/// MongoDB 4.0 or greater.
269269
///
270-
/// See the documentation [here](https://docs.mongodb.com/manual/changeStreams/) on change
270+
/// See the documentation [here](https://www.mongodb.com/docs/manual/changeStreams/) on change
271271
/// streams.
272272
///
273273
/// Change streams require either a "majority" read concern or no read

src/client/options/mod.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ impl<'de> Deserialize<'de> for ServerApiVersion {
312312
}
313313

314314
/// Options used to declare a stable server API. For more information, see the [Stable API](
315-
/// https://docs.mongodb.com/v5.0/reference/stable-api/) manual page.
315+
/// https://www.mongodb.com/docs/v5.0/reference/stable-api/) manual page.
316316
#[serde_with::skip_serializing_none]
317317
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, TypedBuilder)]
318318
#[builder(field_defaults(setter(into)))]
@@ -500,7 +500,7 @@ pub struct ClientOptions {
500500
/// a separate client that declares the appropriate API version.
501501
///
502502
/// For more information, see the [Stable API](
503-
/// https://docs.mongodb.com/v5.0/reference/stable-api/) manual page.
503+
/// https://www.mongodb.com/docs/v5.0/reference/stable-api/) manual page.
504504
#[builder(default)]
505505
pub server_api: Option<ServerApi>,
506506

@@ -676,7 +676,7 @@ impl Serialize for ClientOptions {
676676

677677
/// Contains the options that can be set via a MongoDB connection string.
678678
///
679-
/// The format of a MongoDB connection string is described [here](https://docs.mongodb.com/manual/reference/connection-string/#connection-string-formats).
679+
/// The format of a MongoDB connection string is described [here](https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-formats).
680680
#[derive(Debug, Default, PartialEq)]
681681
#[non_exhaustive]
682682
pub struct ConnectionString {
@@ -1000,7 +1000,7 @@ impl ClientOptions {
10001000
/// In the case that "mongodb+srv" is used, SRV and TXT record lookups will be done as
10011001
/// part of this method.
10021002
///
1003-
/// The format of a MongoDB connection string is described [here](https://docs.mongodb.com/manual/reference/connection-string/#connection-string-formats).
1003+
/// The format of a MongoDB connection string is described [here](https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-formats).
10041004
///
10051005
/// Note that [default_database](ClientOptions::default_database) will be set from
10061006
/// `/defaultauthdb` in connection string.
@@ -1071,7 +1071,7 @@ impl ClientOptions {
10711071
/// In the case that "mongodb+srv" is used, SRV and TXT record lookups will be done using the
10721072
/// provided `ResolverConfig` as part of this method.
10731073
///
1074-
/// The format of a MongoDB connection string is described [here](https://docs.mongodb.com/manual/reference/connection-string/#connection-string-formats).
1074+
/// The format of a MongoDB connection string is described [here](https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-formats).
10751075
///
10761076
/// See the docstring on `ClientOptions::parse` for information on how the various URI options
10771077
/// map to fields on `ClientOptions`.
@@ -2586,7 +2586,7 @@ pub struct SessionOptions {
25862586
pub default_transaction_options: Option<TransactionOptions>,
25872587

25882588
/// If true, all operations performed in the context of this session
2589-
/// will be [causally consistent](https://docs.mongodb.com/manual/core/causal-consistency-read-write-concerns/).
2589+
/// will be [causally consistent](https://www.mongodb.com/docs/manual/core/causal-consistency-read-write-concerns/).
25902590
///
25912591
/// Defaults to true if [`SessionOptions::snapshot`] is unspecified.
25922592
pub causal_consistency: Option<bool>,

src/client/session/cluster_time.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::bson::{Document, Timestamp};
55

66
/// Struct modeling a cluster time reported by the server.
77
///
8-
/// See [the MongoDB documentation](https://docs.mongodb.com/manual/core/read-isolation-consistency-recency/)
8+
/// See [the MongoDB documentation](https://www.mongodb.com/docs/manual/core/read-isolation-consistency-recency/)
99
/// for more information.
1010
#[derive(Debug, Deserialize, Clone, Serialize, Derivative)]
1111
#[derivative(PartialEq, Eq)]

src/client/session/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ lazy_static! {
4646
/// ## Transactions
4747
/// Transactions are used to execute a series of operations across multiple documents and
4848
/// collections atomically. For more information about when and how to use transactions in MongoDB,
49-
/// see the [manual](https://docs.mongodb.com/manual/core/transactions/).
49+
/// see the [manual](https://www.mongodb.com/docs/manual/core/transactions/).
5050
///
5151
/// Replica set transactions are supported on MongoDB 4.0+. Sharded transactions are supported on
5252
/// MongoDDB 4.2+. Transactions are associated with a `ClientSession`. To begin a transaction, call
@@ -452,7 +452,7 @@ impl ClientSession {
452452
///
453453
/// This operation will retry once upon failure if the connection and encountered error support
454454
/// retryability. See the documentation
455-
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
455+
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
456456
/// retryable writes.
457457
pub async fn commit_transaction(&mut self) -> Result<()> {
458458
match &mut self.transaction.state {
@@ -520,7 +520,7 @@ impl ClientSession {
520520
///
521521
/// This operation will retry once upon failure if the connection and encountered error support
522522
/// retryability. See the documentation
523-
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
523+
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
524524
/// retryable writes.
525525
pub async fn abort_transaction(&mut self) -> Result<()> {
526526
match self.transaction.state {

0 commit comments

Comments
 (0)