Automattic / Automattic/monk

Monk Create Index Documentation

Open
#272 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1.8k
Forks
180
PR merge metrics
No merged PRs in 30d

Description

While doing this:
**users.index({"username": 1}, {unique: true});**
I get a deprecation notice like this:
**DEPRECATED (collection.ensureIndex): use collection.createIndex instead (see https://Automattic.github.io/monk/docs/collection/createIndex.html)**
But on the documentation page ie https://Automattic.github.io/monk/docs/collection/createIndex.html, no such warning is listed. So I guess documentation needs a update about deprecation?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start from the collection/createIndex documentation page linked in the issue and compare its index examples with the deprecation notice produced by users.index({"username": 1}, {unique: true}). Update the documentation to explain the deprecated ensureIndex behavior and the createIndex replacement, then verify the rendered page includes the warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, mongodb
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.