spring-projects / spring-projects/spring-data-mongodb

Potential documentation updates

Open
#4,781 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: documentation
Dominant language
Java
Stars
1.7k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

Since I'm going through the docs to better understand all concepts related to MongoDB and I'm quite a noob as far as the database is concerned I will describe any issues with the docs that I found in the meantime

  • My first issue was this one https://github.com/spring-projects/spring-data-mongodb/issues/4760 , I tried to read more about the IndexInfo class and indexes in Mongo as such. The javadocs of IndexInfo are non existant - there's no link nor description of any of the fields such as sparse or language that are not self-explanatory. I then checked the docs about index and collection management and there was nothing there about any of the additional fields. Then I checked the Mongo DB docs about indexes and nothing was there either. Finally it was Mark who pointed me out to the subsection of the index docs in the mongo docs which I would for sure read about today (I only started yesterday). Summing it up it would be helpful to link either through the docs (preferable I guess) or javadocs to the mongo docs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the IndexInfo Javadocs and the linked Spring Data MongoDB index and collection management documentation, then compare the sparse and language fields with the relevant MongoDB index documentation. Done means the non-obvious IndexInfo fields are described or linked to the appropriate MongoDB references.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.