Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Potential documentation updates #4781

Open
marcingrzejszczak opened this issue Sep 11, 2024 · 0 comments
Open

Potential documentation updates #4781

marcingrzejszczak opened this issue Sep 11, 2024 · 0 comments
Labels
type: documentation A documentation update

Comments

@marcingrzejszczak
Copy link
Contributor

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 IndexInfo does not expose background option of the index #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
@marcingrzejszczak marcingrzejszczak added the type: documentation A documentation update label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

1 participant