Skip to content

Commit 4073eaf

Browse files
authored
chore(docs): update docs URLs to use the new endpoint MONGOSH-1349 (#2456)
While any links with the old URL structure will be redirected indefinitely, it would be good to update the links for consistency.
1 parent 49493f4 commit 4073eaf

File tree

11 files changed

+351
-351
lines changed

11 files changed

+351
-351
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This repository is a monorepo for all the various components in the MongoDB Shel
88
all environments (REPL, Browser, Compass, etc).
99

1010
For our official documentation, please visit [MongoDB Docs
11-
page](https://docs.mongodb.com/mongodb-shell).
11+
page](https://mongodb.com/docs/mongodb-shell).
1212

1313
MongoDB Shell works with MongoDB servers >= 4.0.
1414

@@ -108,7 +108,7 @@ variable. For detailed instructions for each of our supported platforms, please
108108
Start mongosh using 'ships' database on specified connection string:
109109
$ mongosh mongodb://192.168.0.5:9999/ships
110110

111-
For more information on usage: https://docs.mongodb.com/mongodb-shell.
111+
For more information on usage: https://mongodb.com/docs/mongodb-shell.
112112
```
113113

114114
<!-- /AUTOMATICALLY_INSERT_CLI_USAGE -->

packages/cli-repl/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ of mongosh, visit https://www.mongodb.com/try/download/shell.
9393
Start mongosh using 'ships' database on specified connection string:
9494
$ mongosh mongodb://192.168.0.5:9999/ships
9595

96-
For more information on usage: https://docs.mongodb.com/mongodb-shell.
96+
For more information on usage: https://mongodb.com/docs/mongodb-shell.
9797
```
9898

9999
<!-- /AUTOMATICALLY_INSERT_CLI_USAGE -->
@@ -306,5 +306,5 @@ npm install --save @mongosh/cli-repl
306306
[mongosh]: https://github.com/mongodb-js/mongosh
307307
[evergreen-url]: https://evergreen.mongodb.com/waterfall/mongosh
308308
[pino-js]: https://github.com/pinojs/pino
309-
[object-id]: https://docs.mongodb.com/manual/reference/method/ObjectId/
309+
[object-id]: https://mongodb.com/docs/manual/reference/method/ObjectId/
310310
[error-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error

packages/cli-repl/src/constants.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ export const USAGE = `
181181
${clr('$ mongosh mongodb://192.168.0.5:9999/ships', 'mongosh:uri')}
182182
183183
${clr(i18n.__('cli-repl.args.moreInformation'), 'bold')} ${clr(
184-
'https://docs.mongodb.com/mongodb-shell',
184+
'https://mongodb.com/docs/mongodb-shell',
185185
'mongosh:uri'
186186
)}.
187187
`

packages/cli-repl/src/format-output.spec.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ test 558.79 GiB
510510
format({
511511
value: {
512512
help: 'Shell API',
513-
docs: 'https://docs.mongodb.com',
513+
docs: 'https://mongodb.com/docs',
514514
attr: [
515515
{
516516
name: 'show dbs',
@@ -530,7 +530,7 @@ test 558.79 GiB
530530
format({
531531
value: {
532532
help: 'Shell API',
533-
docs: 'https://docs.mongodb.com',
533+
docs: 'https://mongodb.com/docs',
534534
attr: [
535535
{
536536
description: 'list available databases',
@@ -561,7 +561,7 @@ test 558.79 GiB
561561
})
562562
);
563563

564-
expect(output).to.not.contain('https://docs.mongodb.com');
564+
expect(output).to.not.contain('https://mongodb.com/docs');
565565
expect(output).to.contain('list available databases');
566566
});
567567

packages/i18n/src/locales/en_US.ts

Lines changed: 337 additions & 337 deletions
Large diffs are not rendered by default.

packages/mongosh/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ of mongosh, visit https://www.mongodb.com/try/download/shell.
9797
Start mongosh using 'ships' database on specified connection string:
9898
$ mongosh mongodb://192.168.0.5:9999/ships
9999

100-
For more information on usage: https://docs.mongodb.com/mongodb-shell.
100+
For more information on usage: https://mongodb.com/docs/mongodb-shell.
101101
```
102102

103103
<!-- /AUTOMATICALLY_INSERT_CLI_USAGE -->

packages/node-runtime-worker-thread/src/worker-runtime.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ describe('worker-runtime', function () {
207207
expect(printable).to.have.property('help', 'Shell Help');
208208
expect(printable)
209209
.to.have.property('docs')
210-
.match(/https:\/\/docs.mongodb.com/);
210+
.match(/https:\/\/mongodb.com\/docs/);
211211
},
212212
],
213213
];

packages/shell-api/src/collection.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2016,7 +2016,7 @@ export default class Collection extends ShellApiWithMongoClass {
20162016
optionsOrOutString: MapReduceShellOptions
20172017
): Promise<Document> {
20182018
await this._instanceState.printDeprecationWarning(
2019-
'Collection.mapReduce() is deprecated. Use an aggregation instead.\nSee https://docs.mongodb.com/manual/core/map-reduce for details.'
2019+
'Collection.mapReduce() is deprecated. Use an aggregation instead.\nSee https://mongodb.com/docs/manual/core/map-reduce for details.'
20202020
);
20212021
assertArgsDefinedType(
20222022
[map, reduce, optionsOrOutString],

packages/shell-api/src/field-level-encryption.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ export class KeyVault extends ShellApiWithMongoClass {
326326
if (typeof masterKeyOrAltNamesOrDataKeyOptions === 'string') {
327327
if (kms === 'local' && masterKeyOrAltNamesOrDataKeyOptions === '') {
328328
// allowed in the old shell - even enforced prior to 4.2.3
329-
// https://docs.mongodb.com/manual/reference/method/KeyVault.createKey/
329+
// https://mongodb.com/docs/manual/reference/method/KeyVault.createKey/
330330
masterKey = undefined;
331331
} else {
332332
throw new MongoshInvalidInputError(

packages/shell-api/src/helpers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1100,7 +1100,7 @@ export function markAsExplainOutput<T extends NotAPromise>(value: T): T {
11001100
return value;
11011101
}
11021102

1103-
// https://docs.mongodb.com/v5.0/reference/limits/#naming-restrictions
1103+
// https://mongodb.com/docs/v5.0/reference/limits/#naming-restrictions
11041104
// For db names, $ can be valid in some contexts (e.g. $external),
11051105
// so we let the server reject it if necessary.
11061106
export function isValidDatabaseName(name: string): boolean {

0 commit comments

Comments
 (0)