Skip to content

Commit d93532c

Browse files
DOCSP-20374: Migrate docs.mongodb.com to mongodb.com/docs (#903)
Also updates a few broken links Co-authored-by: Jeremy Mikola <[email protected]>
1 parent 5ef7251 commit d93532c

Some content is hidden

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

58 files changed

+93
-94
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you've identified a security vulnerability in a driver or any other MongoDB
1616
project, please create a vulnerability report[^2].
1717
1818
[^1]: https://github.com/mongodb/mongo-php-driver
19-
[^2]: https://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report
19+
[^2]: https://mongodb.com/docs/manual/tutorial/create-a-vulnerability-report
2020
-->
2121

2222
### Bug Report

.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ contact_links:
88
url: https://developer.mongodb.com/community/forums/
99
about: For questions, discussions, or general technical support, visit the MongoDB Community Forums. The MongoDB Community Forums are a centralized place to connect with other MongoDB users, ask questions, and get answers.
1010
- name: Report a Security Vulnerability
11-
url: https://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report
11+
url: https://mongodb.com/docs/manual/tutorial/create-a-vulnerability-report
1212
about: If you believe you have discovered a vulnerability in MongoDB products or have experienced a security incident related to MongoDB products, please report the issue to aid in its resolution.

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ $JIRA_URL
197197
**Documentation**
198198
199199
Documentation for this library may be found at:
200-
https://docs.mongodb.com/php-library/
200+
https://mongodb.com/docs/php-library/current/
201201
202202
**Installation**
203203
@@ -231,13 +231,13 @@ New major and minor releases will also require documentation updates to other
231231
projects:
232232

233233
* Create a DOCSP ticket to add the new version to PHP's server and language
234-
[compatibility tables](https://docs.mongodb.com/drivers/php/#compatibility)
234+
[compatibility tables](https://mongodb.com/docs/drivers/php/#compatibility)
235235
in the driver docs portal. See
236236
[mongodb/docs-ecosystem#642](https://github.com/mongodb/docs-ecosystem/pull/642)
237237
for an example.
238238

239239
* Create a DOCSP ticket to update the "current" and "upcoming" navigation links
240-
in the library's [documentation](https://docs.mongodb.com/php-library/). This
240+
in the library's [documentation](https://mongodb.com/docs/php-library/current). This
241241
will require updating
242242
[mongodb/docs-php-library](https://github.com/mongodb/docs-php-library).
243243

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ extension may be found in
2121

2222
## Documentation
2323

24-
- https://docs.mongodb.com/php-library/
25-
- https://docs.mongodb.com/ecosystem/drivers/php/
24+
- https://mongodb.com/docs/php-library/current
25+
- https://mongodb.com/docs/ecosystem/drivers/php/
2626

2727
## Installation
2828

@@ -33,7 +33,7 @@ root:
3333
$ composer require mongodb/mongodb
3434

3535
Additional installation instructions may be found in the
36-
[library documentation](https://docs.mongodb.com/php-library/current/tutorial/install-php-library/).
36+
[library documentation](https://mongodb.com/docs/php-library/current/tutorial/install-php-library/).
3737

3838
Since this library is a high-level abstraction for the driver, it also requires
3939
that the `mongodb` extension be installed:
@@ -53,13 +53,13 @@ project in MongoDB's JIRA. Extension-related issues should be reported in the
5353
project.
5454

5555
For general questions and support requests, please use one of MongoDB's
56-
[Technical Support](https://docs.mongodb.com/manual/support/) channels.
56+
[Technical Support](https://mongodb.com/docs/manual/support/) channels.
5757

5858
### Security Vulnerabilities
5959

6060
If you've identified a security vulnerability in a driver or any other MongoDB
6161
project, please report it according to the instructions in
62-
[Create a Vulnerability Report](https://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
62+
[Create a Vulnerability Report](https://mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
6363

6464
## Development
6565

docs/includes/apiargs-MongoDBClient-method-listDatabases-option.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: boolean
44
description: |
55
A flag that determines which databases are returned based on the user
66
privileges when access control is enabled. For more information, see the
7-
`listDatabases command documentation <https://docs.mongodb.com/manual/reference/command/listDatabases/>`_.
7+
`listDatabases command documentation <https://mongodb.com/docs/manual/reference/command/listDatabases/>`_.
88
99
For servers < 4.0.5, this option is ignored.
1010
@@ -36,4 +36,3 @@ source:
3636
ref: session
3737
post: |
3838
.. versionadded:: 1.3
39-
...

docs/includes/apiargs-MongoDBCollection-common-param.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ description: |
2525
Specifies the field and value combinations to update and any relevant update
2626
operators. ``$update`` uses MongoDB's :method:`update operators
2727
</reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
28-
pipeline <https://docs.mongodb.com/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
28+
pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
2929
can be passed as this parameter.
3030
interface: phpmethod
3131
operation: ~

docs/includes/apiargs-MongoDBDatabase-method-listCollections-option.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: boolean
44
description: |
55
A flag that determines which collections are returned based on the user
66
privileges when access control is enabled. For more information, see the
7-
`listCollections command documentation <https://docs.mongodb.com/manual/reference/command/listCollections/>`_.
7+
`listCollections command documentation <https://mongodb.com/docs/manual/reference/command/listCollections/>`_.
88
99
For servers < 4.0, this option is ignored.
1010

src/ChangeStream.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* @api
3636
* @see \MongoDB\Collection::watch()
37-
* @see http://docs.mongodb.org/manual/reference/command/changeStream/
37+
* @see https://mongodb.com/docs/manual/reference/method/db.watch/#mongodb-method-db.watch
3838
*/
3939
class ChangeStream implements Iterator
4040
{

src/Client.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class Client
8888
*
8989
* Other options are documented in MongoDB\Driver\Manager::__construct().
9090
*
91-
* @see http://docs.mongodb.org/manual/reference/connection-string/
91+
* @see http://mongodb.com/docs/manual/reference/connection-string/
9292
* @see http://php.net/manual/en/mongodb-driver-manager.construct.php
9393
* @see http://php.net/manual/en/mongodb.persistence.php#mongodb.persistence.typemaps
9494
* @param string $uri MongoDB connection string

src/Collection.php

+18-18
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ public function __debugInfo()
183183
/**
184184
* Return the collection namespace (e.g. "db.collection").
185185
*
186-
* @see https://docs.mongodb.org/manual/faq/developers/#faq-dev-namespace
186+
* @see https://mongodb.com/docs/manual/core/databases-and-collections/
187187
* @return string
188188
*/
189189
public function __toString()
@@ -368,8 +368,8 @@ public function createIndex($key, array $options = [])
368368
* If the "name" option is unspecified, a name will be generated from the
369369
* "key" document.
370370
*
371-
* @see http://docs.mongodb.org/manual/reference/command/createIndexes/
372-
* @see http://docs.mongodb.org/manual/reference/method/db.collection.createIndex/
371+
* @see http://mongodb.com/docs/manual/reference/command/createIndexes/
372+
* @see http://mongodb.com/docs/manual/reference/method/db.collection.createIndex/
373373
* @see CreateIndexes::__construct() for supported command options
374374
* @param array[] $indexes List of index specifications
375375
* @param array $options Command options
@@ -395,7 +395,7 @@ public function createIndexes(array $indexes, array $options = [])
395395
* Deletes all documents matching the filter.
396396
*
397397
* @see DeleteMany::__construct() for supported options
398-
* @see http://docs.mongodb.org/manual/reference/command/delete/
398+
* @see http://mongodb.com/docs/manual/reference/command/delete/
399399
* @param array|object $filter Query by which to delete documents
400400
* @param array $options Command options
401401
* @return DeleteResult
@@ -419,7 +419,7 @@ public function deleteMany($filter, array $options = [])
419419
* Deletes at most one document matching the filter.
420420
*
421421
* @see DeleteOne::__construct() for supported options
422-
* @see http://docs.mongodb.org/manual/reference/command/delete/
422+
* @see http://mongodb.com/docs/manual/reference/command/delete/
423423
* @param array|object $filter Query by which to delete documents
424424
* @param array $options Command options
425425
* @return DeleteResult
@@ -593,7 +593,7 @@ public function estimatedDocumentCount(array $options = [])
593593
* Explains explainable commands.
594594
*
595595
* @see Explain::__construct() for supported options
596-
* @see http://docs.mongodb.org/manual/reference/command/explain/
596+
* @see http://mongodb.com/docs/manual/reference/command/explain/
597597
* @param Explainable $explainable Command on which to run explain
598598
* @param array $options Additional options
599599
* @return array|object
@@ -622,7 +622,7 @@ public function explain(Explainable $explainable, array $options = [])
622622
* Finds documents matching the query.
623623
*
624624
* @see Find::__construct() for supported options
625-
* @see http://docs.mongodb.org/manual/core/read-operations-introduction/
625+
* @see https://mongodb.com/docs/manual/crud/#read-operations
626626
* @param array|object $filter Query by which to filter documents
627627
* @param array $options Additional options
628628
* @return Cursor
@@ -655,7 +655,7 @@ public function find($filter = [], array $options = [])
655655
* Finds a single document matching the query.
656656
*
657657
* @see FindOne::__construct() for supported options
658-
* @see http://docs.mongodb.org/manual/core/read-operations-introduction/
658+
* @see https://mongodb.com/docs/manual/crud/#read-operations
659659
* @param array|object $filter Query by which to filter documents
660660
* @param array $options Additional options
661661
* @return array|object|null
@@ -690,7 +690,7 @@ public function findOne($filter = [], array $options = [])
690690
* The document to return may be null if no document matched the filter.
691691
*
692692
* @see FindOneAndDelete::__construct() for supported options
693-
* @see http://docs.mongodb.org/manual/reference/command/findAndModify/
693+
* @see http://mongodb.com/docs/manual/reference/command/findAndModify/
694694
* @param array|object $filter Query by which to filter documents
695695
* @param array $options Command options
696696
* @return array|object|null
@@ -726,7 +726,7 @@ public function findOneAndDelete($filter, array $options = [])
726726
* to return the updated document.
727727
*
728728
* @see FindOneAndReplace::__construct() for supported options
729-
* @see http://docs.mongodb.org/manual/reference/command/findAndModify/
729+
* @see http://mongodb.com/docs/manual/reference/command/findAndModify/
730730
* @param array|object $filter Query by which to filter documents
731731
* @param array|object $replacement Replacement document
732732
* @param array $options Command options
@@ -763,7 +763,7 @@ public function findOneAndReplace($filter, $replacement, array $options = [])
763763
* to return the updated document.
764764
*
765765
* @see FindOneAndReplace::__construct() for supported options
766-
* @see http://docs.mongodb.org/manual/reference/command/findAndModify/
766+
* @see http://mongodb.com/docs/manual/reference/command/findAndModify/
767767
* @param array|object $filter Query by which to filter documents
768768
* @param array|object $update Update to apply to the matched document
769769
* @param array $options Command options
@@ -823,7 +823,7 @@ public function getManager()
823823
/**
824824
* Return the collection namespace.
825825
*
826-
* @see https://docs.mongodb.org/manual/reference/glossary/#term-namespace
826+
* @see https://mongodb.com/docs/manual/reference/glossary/#term-namespace
827827
* @return string
828828
*/
829829
public function getNamespace()
@@ -877,7 +877,7 @@ public function getWriteConcern()
877877
* Inserts multiple documents.
878878
*
879879
* @see InsertMany::__construct() for supported options
880-
* @see http://docs.mongodb.org/manual/reference/command/insert/
880+
* @see http://mongodb.com/docs/manual/reference/command/insert/
881881
* @param array[]|object[] $documents The documents to insert
882882
* @param array $options Command options
883883
* @return InsertManyResult
@@ -900,7 +900,7 @@ public function insertMany(array $documents, array $options = [])
900900
* Inserts one document.
901901
*
902902
* @see InsertOne::__construct() for supported options
903-
* @see http://docs.mongodb.org/manual/reference/command/insert/
903+
* @see http://mongodb.com/docs/manual/reference/command/insert/
904904
* @param array|object $document The document to insert
905905
* @param array $options Command options
906906
* @return InsertOneResult
@@ -940,7 +940,7 @@ public function listIndexes(array $options = [])
940940
* Executes a map-reduce aggregation on the collection.
941941
*
942942
* @see MapReduce::__construct() for supported options
943-
* @see http://docs.mongodb.org/manual/reference/command/mapReduce/
943+
* @see http://mongodb.com/docs/manual/reference/command/mapReduce/
944944
* @param JavascriptInterface $map Map function
945945
* @param JavascriptInterface $reduce Reduce function
946946
* @param string|array|object $out Output specification
@@ -1025,7 +1025,7 @@ public function rename(string $toCollectionName, ?string $toDatabaseName = null,
10251025
* Replaces at most one document matching the filter.
10261026
*
10271027
* @see ReplaceOne::__construct() for supported options
1028-
* @see http://docs.mongodb.org/manual/reference/command/update/
1028+
* @see http://mongodb.com/docs/manual/reference/command/update/
10291029
* @param array|object $filter Query by which to filter documents
10301030
* @param array|object $replacement Replacement document
10311031
* @param array $options Command options
@@ -1050,7 +1050,7 @@ public function replaceOne($filter, $replacement, array $options = [])
10501050
* Updates all documents matching the filter.
10511051
*
10521052
* @see UpdateMany::__construct() for supported options
1053-
* @see http://docs.mongodb.org/manual/reference/command/update/
1053+
* @see http://mongodb.com/docs/manual/reference/command/update/
10541054
* @param array|object $filter Query by which to filter documents
10551055
* @param array|object $update Update to apply to the matched documents
10561056
* @param array $options Command options
@@ -1075,7 +1075,7 @@ public function updateMany($filter, $update, array $options = [])
10751075
* Updates at most one document matching the filter.
10761076
*
10771077
* @see UpdateOne::__construct() for supported options
1078-
* @see http://docs.mongodb.org/manual/reference/command/update/
1078+
* @see http://mongodb.com/docs/manual/reference/command/update/
10791079
* @param array|object $filter Query by which to filter documents
10801080
* @param array|object $update Update to apply to the matched document
10811081
* @param array $options Command options

src/Command/ListCollections.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* Wrapper for the listCollections command.
3535
*
3636
* @internal
37-
* @see http://docs.mongodb.org/manual/reference/command/listCollections/
37+
* @see http://mongodb.com/docs/manual/reference/command/listCollections/
3838
*/
3939
class ListCollections implements Executable
4040
{

src/Command/ListDatabases.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* Wrapper for the ListDatabases command.
3636
*
3737
* @internal
38-
* @see http://docs.mongodb.org/manual/reference/command/listDatabases/
38+
* @see http://mongodb.com/docs/manual/reference/command/listDatabases/
3939
*/
4040
class ListDatabases implements Executable
4141
{

src/MapReduceResult.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
*
3434
* @api
3535
* @see \MongoDB\Collection::mapReduce()
36-
* @see https://docs.mongodb.com/manual/reference/command/mapReduce/
36+
* @see https://mongodb.com/docs/manual/reference/command/mapReduce/
3737
*/
3838
class MapReduceResult implements IteratorAggregate
3939
{

src/Model/CollectionInfo.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public function getIdIndex(): array
9797
/**
9898
* Return the "info" property of the server response.
9999
*
100-
* @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
100+
* @see https://mongodb.com/docs/manual/reference/command/listCollections/#output
101101
* @return array
102102
*/
103103
public function getInfo(): array
@@ -108,7 +108,7 @@ public function getInfo(): array
108108
/**
109109
* Return the collection name.
110110
*
111-
* @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
111+
* @see https://mongodb.com/docs/manual/reference/command/listCollections/#output
112112
* @return string
113113
*/
114114
public function getName()
@@ -119,7 +119,7 @@ public function getName()
119119
/**
120120
* Return the collection options.
121121
*
122-
* @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
122+
* @see https://mongodb.com/docs/manual/reference/command/listCollections/#output
123123
* @return array
124124
*/
125125
public function getOptions()
@@ -130,7 +130,7 @@ public function getOptions()
130130
/**
131131
* Return the collection type.
132132
*
133-
* @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
133+
* @see https://mongodb.com/docs/manual/reference/command/listCollections/#output
134134
* @return string
135135
*/
136136
public function getType(): string

src/Model/CollectionInfoCommandIterator.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* @internal
3131
* @see \MongoDB\Database::listCollections()
3232
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
33-
* @see http://docs.mongodb.org/manual/reference/command/listCollections/
33+
* @see http://mongodb.com/docs/manual/reference/command/listCollections/
3434
*/
3535
class CollectionInfoCommandIterator extends IteratorIterator implements CollectionInfoIterator
3636
{

src/Model/DatabaseInfo.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*
3232
* @api
3333
* @see \MongoDB\Client::listDatabases()
34-
* @see http://docs.mongodb.org/manual/reference/command/listDatabases/
34+
* @see http://mongodb.com/docs/manual/reference/command/listDatabases/
3535
*/
3636
class DatabaseInfo implements ArrayAccess
3737
{

src/Model/DatabaseInfoLegacyIterator.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
*
3333
* @internal
3434
* @see \MongoDB\Client::listDatabases()
35-
* @see http://docs.mongodb.org/manual/reference/command/listDatabases/
35+
* @see http://mongodb.com/docs/manual/reference/command/listDatabases/
3636
*/
3737
class DatabaseInfoLegacyIterator implements DatabaseInfoIterator
3838
{

0 commit comments

Comments
 (0)