Skip to content

Commit a3aa060

Browse files
nbbeekenemadumdariakpaddaleax
authored
docs(NODE-2329): write upgrade and migration guide (#2890)
Co-authored-by: Eric Adum <[email protected]> Co-authored-by: Daria Pardue <[email protected]> Co-authored-by: Anna Henningsen <[email protected]>
1 parent 523e05c commit a3aa060

File tree

3 files changed

+414
-30
lines changed

3 files changed

+414
-30
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
The official [MongoDB](https://www.mongodb.com/) driver for Node.js.
44

5-
**NOTE: v4.x was recently released with breaking API changes. You can find a list of changes [here](https://github.com/mongodb/node-mongodb-native/blob/4.0/HISTORY.md).**
5+
**Upgrading to version 4? Take a look at our [upgrade guide here](https://github.com/mongodb/node-mongodb-native/blob/4.0/docs/CHANGES_4.0.0.md)!**
66

77
## Quick Links
88

9-
| what | where |
10-
|---------------|------------------------------------------------------------------------------------------------------------------|
11-
| documentation | [https://docs.mongodb.com/drivers/node](https://docs.mongodb.com/drivers/node) |
12-
| api-doc | [https://mongodb.github.io/node-mongodb-native/4.0/](https://mongodb.github.io/node-mongodb-native/4.0/) |
13-
| npm package | [https://www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) |
14-
| source | [https://github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) |
15-
| mongodb | [https://www.mongodb.com](https://www.mongodb.com) |
9+
| what | where |
10+
| ------------- | ------------------------------------------------------------------------------------------------------ |
11+
| documentation | [docs.mongodb.com/drivers/node](https://docs.mongodb.com/drivers/node) |
12+
| api-doc | [mongodb.github.io/node-mongodb-native/4.0/](https://mongodb.github.io/node-mongodb-native/4.0/) |
13+
| npm package | [www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) |
14+
| source | [github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) |
15+
| mongodb | [www.mongodb.com](https://www.mongodb.com) |
16+
| changelog | [HISTORY.md](https://github.com/mongodb/node-mongodb-native/blob/4.0/docs/HISTORY.md) |
17+
| upgrade to v4 | [docs/CHANGES_4.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/4.0/docs/CHANGES_4.0.0.md) |
1618

1719
### Bugs / Feature Requests
1820

@@ -103,7 +105,7 @@ For complete MongoDB installation instructions, see [the manual](https://docs.mo
103105

104106
1. Download the right MongoDB version from [MongoDB](https://www.mongodb.org/downloads)
105107
2. Create a database directory (in this case under **/data**).
106-
3. Install and start a ``mongod`` process.
108+
3. Install and start a `mongod` process.
107109

108110
```bash
109111
mongod --dbpath=/data
@@ -194,7 +196,7 @@ const filteredDocs = await collection.find({ a: 3 }).toArray()
194196
console.log('Found documents filtered by { a: 3 } =>', filteredDocs)
195197
```
196198

197-
Only the documents which match ``'a' : 3`` should be returned.
199+
Only the documents which match `'a' : 3` should be returned.
198200

199201
### Update a document
200202

@@ -223,7 +225,7 @@ performance. The following function creates an index on the **a** field in the
223225
**documents** collection.
224226

225227
```js
226-
const indexName = await collection.createIndex({a: 1})
228+
const indexName = await collection.createIndex({ a: 1 })
227229
console.log('index name =', indexName)
228230
```
229231

0 commit comments

Comments
 (0)