Skip to content

Commit effc286

Browse files
CXX-2480 documentation link cleanup
Use new docs URL, change mongodb.org to .com, fix dead links --------- Co-authored-by: Ezra Chung <[email protected]>
1 parent 5063d52 commit effc286

File tree

87 files changed

+460
-460
lines changed

Some content is hidden

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

87 files changed

+460
-460
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ for more details about the various versions of the driver.
2626
* [MongoDB C++ Driver Documentation](https://www.mongodb.com/docs/drivers/cxx/)
2727
* [MongoDB C++ Driver API Documentation](https://mongocxx.org/api/current/)
2828
* [MongoDB C++ Driver Contribution guidelines](https://mongocxx.org/contributing/)
29-
* [MongoDB Database Manual](https://docs.mongodb.com/manual/)
29+
* [MongoDB Database Manual](https://www.mongodb.com/docs/manual/)
3030
* [MongoDB Developer Center](https://www.mongodb.com/developer/languages/cpp/)
3131
* [StackOverflow](https://stackoverflow.com/questions/tagged/mongodb%20c%2b%2b)
3232

@@ -50,11 +50,11 @@ Currently, no drivers guarantee API or ABI stability.
5050

5151
## MongoDB compatibility
5252

53-
Compatibility of each C++ driver version with each MongoDB server is documented in the [MongoDB manual](https://docs.mongodb.com/drivers/cxx#mongodb-compatibility).
53+
Compatibility of each C++ driver version with each MongoDB server is documented in the [MongoDB manual](https://www.mongodb.com/docs/drivers/cxx#mongodb-compatibility).
5454

5555
## Bugs and issues
5656

57-
See our [JIRA project](http://jira.mongodb.org/browse/CXX).
57+
See our [JIRA project](https://jira.mongodb.com/browse/CXX).
5858

5959
## License
6060

THIRD-PARTY-NOTICES

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ be distributed under licenses different than the MongoDB software.
44
In the event that we accidentally failed to list a required notice,
55
please bring it to our attention through any of the ways detailed here:
66

7-
https://jira.mongodb.org/browse/CXX
7+
https://jira.mongodb.com/browse/CXX
88

99
The attached notices are provided for information only.
1010

docs/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Currently, no drivers guarantee API or ABI stability.
3333

3434
## MongoDB compatibility
3535

36-
Compatibility of each C++ driver version with each MongoDB server is documented in the [MongoDB manual](https://docs.mongodb.com/drivers/cxx#mongodb-compatibility).
36+
Compatibility of each C++ driver version with each MongoDB server is documented in the [MongoDB manual](https://www.mongodb.com/docs/drivers/cxx#mongodb-compatibility).
3737

3838
## License
3939

docs/content/getting-help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ title = "Getting help"
88

99
Often, the quickest way to get support for general questions is through
1010
the
11-
[MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/cxx-driver)
11+
[MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/cxx)
1212
or through
1313
[Stack Overflow](https://stackoverflow.com/questions/tagged/mongodb%20c%2b%2b).
1414

1515
Please also refer to MongoDB's
16-
[support channels](https://docs.mongodb.com/manual/support) documentation.
16+
[support channels](https://www.mongodb.com/docs/manual/support) documentation.
1717

docs/content/legacy-v1/breaking-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ run all tests and client examples |`test`
7878
* The driver will not function correctly unless `mongo::client::initialize` is invoked before using the driver APIs. The mongo::client::shutdown method should also be called at application termination (if options.callShutdownAtExit() is not set) so the driver can cleanly terminate. As a convenience, we have added [`mongo::GlobalInstance`](https://github.com/mongodb/mongo-cxx-driver/blob/legacy/src/mongo/client/init.h#L69) as an RAII wrapper to automatically call these methods.
7979
* options.callShutdownAtExit() is a no-op on non-static builds on Windows due to issues around sudden thread termination.
8080
* The driver no longer logs any output by default. You may configure and inject a logger to re-enable logging. See `src/mongo/client/examples/clientTest.cpp` for an example of how to enable logging.
81-
* Writes are now "[acknowledged](https://docs.mongodb.com/manual/core/write-concern/#write-concern-acknowledged)" by default. In all previous releases the default write concern was “[unacknowledged](https://docs.mongodb.com/manual/core/write-concern/#unacknowledged)”. This change may have performance and behavior implications for existing applications that did not confirm writes. You can read more about the change [here](https://docs.mongodb.com/manual/release-notes/drivers-write-concern/#driver-write-concern-change).
81+
* Writes are now "[acknowledged](https://www.mongodb.com/docs/manual/core/write-concern/#write-concern-acknowledged)" by default. In all previous releases the default write concern was “[unacknowledged](https://www.mongodb.com/docs/manual/core/write-concern/#unacknowledged)”. This change may have performance and behavior implications for existing applications that did not confirm writes. You can read more about the change [here](https://www.mongodb.com/docs/manual/release-notes/drivers-write-concern/#driver-write-concern-change).
8282
* The driver now throws a mongo::OperationException when write concern is greater than Acknowledged for errors that occur when running operations against a MongoDB database.
8383
* The default shutdown grace period is now zero which means the driver may block forever until a successful shutdown occurs.
8484

docs/content/legacy-v1/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ if (!status.isOK()) {
151151
- Semantics: This flag only has an effect if `Options::current::SSLMode` is
152152
`Options::kSSLRequired`. If set, it specifies a file containing the
153153
certificate authority file to use. See the [MongoDB SSL
154-
documentation](https://docs.mongodb.com/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
154+
documentation](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
155155
for additional information on the CA file.
156156

157157
#### `Options::setSSLPemKeyFile` and `Options::SSLPEMKeyFile`
@@ -161,7 +161,7 @@ if (!status.isOK()) {
161161
- Semantics: This flag only has an effect if `Options::current::SSLMode` is
162162
`Options::kSSLRequired`. If set, it specifies a file containing the SSL
163163
PEM key file to use. See the [MongoDB SSL
164-
documentation](https://docs.mongodb.com/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
164+
documentation](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
165165
for additional information on the PEM key file.
166166

167167
#### `Options::setSSLPemKeyPassword` and `Options::SSLPEMKeyPassword`
@@ -173,7 +173,7 @@ if (!status.isOK()) {
173173
been set with `Options::setSSLPEMKeyFile`. If set, it specifies the
174174
password to be used to decrypt the SSL PEM key file specified with
175175
`Options::setSSLPEMKeyFile`. See the [MongoDB SSL
176-
documentation](https://docs.mongodb.com/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
176+
documentation](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
177177
for additional information on the PEM key file password.
178178

179179
#### `Options::setSSLCRLFile` and `Options::SSLCRLFile`
@@ -183,7 +183,7 @@ if (!status.isOK()) {
183183
- Semantics: This flag only has an effect if `Options::current::SSLMode` is
184184
`Options::kSSLRequired`. If set, it specifies the file to use as the SSL
185185
certificate revocation list. See the [MongoDB SSL
186-
documentation](https://docs.mongodb.com/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
186+
documentation](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/#set-up-mongod-and-mongos-with-ssl-certificate-and-key)
187187
for additional information on the certificate revocation list file.
188188

189189
#### `Options::setSSAllowInvalidCertificates` and `Options::SSLAllowInvalidCertificates`

docs/content/legacy-v1/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ title = "Installing the legacy driver"
3939
### How to ask for Help
4040

4141
If you are having difficulty building the driver after reading the below
42-
instructions, please post on the [MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/cxx-driver) to ask for
42+
instructions, please post on the [MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/cxx) to ask for
4343
help. Please include in your post **all** of the following information:
4444

4545
- The version of the driver you are trying to build (branch or tag).
@@ -169,7 +169,7 @@ have linked against libstdc++.
169169
There are several targets you can build, but the most common target for users of the library is `install`, which will build the driver, and install the driver and headers to the location specified with the `--prefix` argument. If no prefix is specified, `--prefix` defaults to a directory named ```build/install``` under the current source directory.
170170

171171
##### Client Feature Options
172-
- `--ssl` Enables SSL support. You will need a compatible version of the SSL libraries available.The default authorization mechanism since MongoDB version 3.0 is [SCRAM-SHA-1](https://docs.mongodb.com/manual/reference/program/mongo/). If you want to use standard MongoDB authentication, you should compile with --ssl option for SCRAM-SHA-1 mechanism support.
172+
- `--ssl` Enables SSL support. You will need a compatible version of the SSL libraries available.The default authorization mechanism since MongoDB version 3.0 is [SCRAM-SHA-1](https://www.mongodb.com/docs/manual/core/security-scram/). If you want to use standard MongoDB authentication, you should compile with --ssl option for SCRAM-SHA-1 mechanism support.
173173
- `--use-sasl-client` Enables SASL, which MongoDB uses for the Kerberos authentication available on MongoDB Enterprise. You will need a compatible version of the SASL implementation libraries available. The Cyrus SASL libraries are what we test with, and are recommended.
174174
- `--sharedclient` Builds a shared library version of the client driver alongside the static library. If applicable for your application, prefer using the shared client.
175175

@@ -324,7 +324,7 @@ scons
324324

325325
###### Building multiple Windows library variants:
326326

327-
As of legacy-0.8, the Windows libraries are now tagged with boost-like ABI tags (see http://www.boost.org/doc/libs/1_55_0/more/getting_started/windows.html#library-naming), so it is possible to build several different variants (debug vs retail, static vs dynamic runtime) and install them to the same location. We have added support for autolib, so the selection of the appropriate library is handled automatically (see https://jira.mongodb.org/browse/CXX-200). To build all of the different driver variants, repeatedly invoke scons as follows:
327+
As of legacy-0.8, the Windows libraries are now tagged with boost-like ABI tags (see http://www.boost.org/doc/libs/1_55_0/more/getting_started/windows.html#library-naming), so it is possible to build several different variants (debug vs retail, static vs dynamic runtime) and install them to the same location. We have added support for autolib, so the selection of the appropriate library is handled automatically (see https://jira.mongodb.com/browse/CXX-200). To build all of the different driver variants, repeatedly invoke scons as follows:
328328

329329
```
330330
scons $ARGS install

docs/content/legacy-v1/tutorial.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ This is an introduction to usage of the MongoDB database from a C++ program.
1414
NOTE: this tutorial is for the legacy and 26compat versions of the C++ driver.
1515

1616
First, install MongoDB – see the
17-
[installation](https://docs.mongodb.com/manual/installation/) page for
17+
[installation](https://www.mongodb.com/docs/manual/installation/) page for
1818
details.
1919

2020
Next, you may wish to take a look at the [MongoDB
21-
Manual](https://docs.mongodb.com/manual/) for a language independent look at
21+
Manual](https://www.mongodb.com/docs/manual/) for a language independent look at
2222
how to use MongoDB. Also, we suggest some basic familiarity with the [mongo
23-
shell](https://docs.mongodb.com/manual/mongo/) – the shell is the primary
23+
shell](https://www.mongodb.com/docs/mongodb-shell/) – the shell is the primary
2424
database administration tool and is useful for manually inspecting the
2525
contents of a database after your C++ program runs.
2626

@@ -43,7 +43,7 @@ The C++ driver includes several classes for managing collections under the paren
4343
- `DBClientConnection` is the connection class for connecting to a single MongoDB database server (or mongos)
4444
- `DBClientReplicaSet` is the connection class for connecting to a replica set.
4545

46-
See the [API documentation](http://mongodb.github.io/api/1.0.2/) for
46+
See the [API documentation](https://mongodb.github.io/api/1.0.2/) for
4747
details on each of the above classes.
4848

4949
#### A simple program that connects to the database
@@ -188,7 +188,7 @@ BSONObj DBClientWithCommands::getLastErrorDetailed();
188188
For an example, see [this demo](https://github.com/mongodb/mongo-cxx-driver/blob/legacy/src/mongo/client/examples/simple_client_demo.cpp).
189189

190190
For additional background information on getLastError see the [write
191-
operations documentation](https://docs.mongodb.com/manual/core/write-operations/#write-concern).
191+
operations documentation](https://www.mongodb.com/docs/manual/core/write-operations/#write-concern).
192192

193193
### Count
194194

@@ -279,7 +279,7 @@ server operation for each call. It's best practice to use this method
279279
sparingly, for example once at the beginning of your code, or perhaps in an
280280
external setup script that configures the database for your application.
281281
For more information about indexing, see the [MongoDB Indexing
282-
docs](https://docs.mongodb.com/manual/indexes/).
282+
docs](https://www.mongodb.com/docs/manual/indexes/).
283283

284284
### Sorting
285285

@@ -323,7 +323,7 @@ db.update("tutorial.persons",
323323
The `update()` method can be used to modify specific fields, replace the
324324
entire existing document, insert new documents or update multiple
325325
documents. In the MongoDB Manual, examples are provided in the [Modify
326-
Documents Tutorial](https://docs.mongodb.com/manual/tutorial/modify-documents/).
326+
Documents Tutorial](https://www.mongodb.com/docs/manual/tutorial/modify-documents/).
327327

328328
### Arrays
329329

@@ -335,6 +335,6 @@ is available [here](https://github.com/mongodb/mongo-cxx-driver/blob/legacy/src/
335335
This overview just touches on the basics of using MongoDB from C++. There
336336
are many more capabilities. For further exploration:
337337

338-
- See the language-independent [MongoDB Manual](https://docs.mongodb.com/manual/)
339-
- Experiment with the [mongo shell](https://docs.mongodb.com/manual/mongo/)
340-
- Review the [API docs](http://mongodb.github.io/api/1.0.2)
338+
- See the language-independent [MongoDB Manual](https://www.mongodb.com/docs/manual/)
339+
- Experiment with the [mongo shell](https://www.mongodb.com/docs/mongodb-shell/)
340+
- Review the [API docs](https://mongodb.github.io/api/1.0.2)

docs/content/mongocxx-v3/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title = "The mongocxx (v3) driver"
88
+++
99

1010
The mongocxx is a ground-up rewrite of a C++ driver for MongoDB based on
11-
[libmongoc](http://mongoc.org/). It requires a C++11 compiler. It is
11+
[libmongoc](https://mongoc.org/). It requires a C++11 compiler. It is
1212
known to build on x86 and x86-64 architectures for Linux, macOS,
1313
Windows, and FreeBSD.
1414

docs/content/mongocxx-v3/client-side-encryption.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ title = "Client-Side Field Level Encryption with mongocxx"
88

99
## Client-Side Field Level Encryption
1010

11-
New in MongoDB 4.2 [Client-Side Field Level Encryption (CSFLE)](https://docs.mongodb.com/drivers/use-cases/client-side-field-level-encryption-guide) allows administrators and developers to encrypt specific data fields in addition to other MongoDB encryption features.
11+
New in MongoDB 4.2 [Client-Side Field Level Encryption (CSFLE)](https://www.mongodb.com/docs/drivers/use-cases/client-side-field-level-encryption-guide) allows administrators and developers to encrypt specific data fields in addition to other MongoDB encryption features.
1212

1313
With CSFLE, developers can encrypt fields client side without any server-side configuration or directives. Client-Side Field Level Encryption supports workloads where applications must guarantee that unauthorized parties, including server administrators, cannot read the encrypted data.
1414

15-
For an overview of CSFLE, please read [the official MongoDB documentation in the manual](https://docs.mongodb.com/manual/core/security-client-side-encryption/).
15+
For an overview of CSFLE, please read [the official MongoDB documentation in the manual](https://www.mongodb.com/docs/manual/core/security-client-side-encryption/).
1616

1717
## Installation
1818

1919
### libmongocrypt
2020

21-
Client-Side Field Level Encryption relies on a C library called `libmongocrypt` to do the heavy lifting encryption work. This dependency is managed by the C driver. As long as the C driver installation is 1.16.0 or higher, and has been compiled with Client-Side Field Level Encryption support, this dependency should be managed internally. See the C driver's [Using Client-Side Field Level Encryption](http://mongoc.org/libmongoc/current/using_client_side_encryption.html) for more information.
21+
Client-Side Field Level Encryption relies on a C library called `libmongocrypt` to do the heavy lifting encryption work. This dependency is managed by the C driver. As long as the C driver installation is 1.16.0 or higher, and has been compiled with Client-Side Field Level Encryption support, this dependency should be managed internally. See the C driver's [Using Client-Side Field Level Encryption](https://mongoc.org/libmongoc/current/client-side-field-level-encryption.html) for more information.
2222

2323
### mongocryptd
2424

@@ -56,7 +56,7 @@ Automatic client-side field level encryption requires MongoDB 4.2 enterprise or
5656

5757
### Providing Local Automatic Encryption Rules
5858

59-
The following example shows how to specify automatic encryption rules via the schema_map option. The automatic encryption rules are expressed using a [strict subset of the JSON Schema syntax](https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/).
59+
The following example shows how to specify automatic encryption rules via the schema_map option. The automatic encryption rules are expressed using a [strict subset of the JSON Schema syntax](https://www.mongodb.com/docs/manual/reference/security-client-side-automatic-json-schema/).
6060

6161
Supplying a `schema_map` provides more security than relying on JSON Schemas obtained from the server. It protects against a malicious server advertising a false JSON Schema, which could trick the client into sending unencrypted data that should be encrypted.
6262

@@ -89,7 +89,7 @@ Please see [`examples/mongocxx/automatic_client_side_field_level_encryption.cpp`
8989

9090
The MongoDB 4.2 server supports using schema validation to enforce encryption of specific fields in a collection. This schema validation will prevent an application from inserting unencrypted values for any fields marked with the `"encrypt"` JSON schema keyword.
9191

92-
It is possible to set up automatic client-side field level encryption using the `mongocxx::client_encryption` to create a new encryption data key and create a collection with the [Automatic Encryption JSON Schema Syntax](https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/).
92+
It is possible to set up automatic client-side field level encryption using the `mongocxx::client_encryption` to create a new encryption data key and create a collection with the [Automatic Encryption JSON Schema Syntax](https://www.mongodb.com/docs/manual/reference/security-client-side-automatic-json-schema/).
9393

9494
```c++
9595
// Please see the linked example below for full json_schema construction.

0 commit comments

Comments
 (0)