Skip to content

Conversation

rustagir
Copy link
Contributor

@rustagir rustagir commented Jan 27, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-46121

Staging Links

https://deploy-preview-97--docs-mongoid.netlify.app/

redirects:

Redirect 301 /docs/mongoid/ https://www.mongodb.com/docs/mongoid/current/
Redirect 301 /docs/mongoid/stable https://www.mongodb.com/docs/mongoid/current/
Redirect 301 /docs/mongoid/v9.0/compatibility/ https://www.mongodb.com/docs/mongoid/v9.0/reference/compatibility/
Redirect 301 /docs/mongoid/v9.0/configuration/ https://www.mongodb.com/docs/mongoid/v9.0/reference/configuration/
Redirect 301 /docs/mongoid/v9.0/integrations-tools/rails-integration/ https://www.mongodb.com/docs/mongoid/v9.0/reference/rails-integration/
Redirect 301 /docs/mongoid/v9.0/quick-start-sinatra/ https://www.mongodb.com/docs/mongoid/v9.0/tutorials/getting-started-sinatra/
Redirect 301 /docs/mongoid/v9.0/quick-start-rails/ https://www.mongodb.com/docs/mongoid/v9.0/tutorials/getting-started-rails7/
Redirect 301 /docs/mongoid/v9.0/data-modeling/documents/ https://www.mongodb.com/docs/mongoid/v9.0/tutorials/documents/
Redirect 301 /docs/mongoid/v9.0/security/encryption/ https://www.mongodb.com/docs/mongoid/v9.0/tutorials/automatic-encryption/
Redirect 301 /docs/mongoid/v9.0/data-modeling/field-types/ https://www.mongodb.com/docs/mongoid/v9.0/reference/fields/
Redirect 301 /docs/mongoid/v9.0/data-modeling/inheritance/ https://www.mongodb.com/docs/mongoid/v9.0/reference/inheritance/
Redirect 301 /docs/mongoid/v9.0/data-modeling/associations/ https://www.mongodb.com/docs/mongoid/v9.0/reference/associations/
Redirect 301 /docs/mongoid/v9.0/data-modeling/validation/ https://www.mongodb.com/docs/mongoid/v9.0/reference/validation/
Redirect 301 /docs/mongoid/v9.0/configuration/collection-config/ https://www.mongodb.com/docs/mongoid/v9.0/reference/collection-configuration/
Redirect 301 /docs/mongoid/v9.0/data-modeling/indexes/ https://www.mongodb.com/docs/mongoid/v9.0/reference/indexes/
Redirect 301 /docs/mongoid/v9.0/configuration/sharding/ https://www.mongodb.com/docs/mongoid/v9.0/reference/sharding/
Redirect 301 /docs/mongoid/v9.0/interact-data/crud/ https://www.mongodb.com/docs/mongoid/v9.0/reference/crud/
Redirect 301 /docs/mongoid/v9.0/interact-data/specify-query/ https://www.mongodb.com/docs/mongoid/v9.0/reference/queries/
Redirect 301 /docs/mongoid/v9.0/interact-data/text-search/ https://www.mongodb.com/docs/mongoid/v9.0/reference/text-search/
Redirect 301 /docs/mongoid/v9.0/interact-data/aggregation/ https://www.mongodb.com/docs/mongoid/v9.0/reference/aggregation/
Redirect 301 /docs/mongoid/v9.0/configuration/persistence-config/ https://www.mongodb.com/docs/mongoid/v9.0/reference/persistence-configuration/
Redirect 301 /docs/mongoid/v9.0/interact-data/nested-attributes/ https://www.mongodb.com/docs/mongoid/v9.0/reference/nested-attributes/
Redirect 301 /docs/mongoid/v9.0/data-modeling/callbacks/ https://www.mongodb.com/docs/mongoid/v9.0/reference/callbacks/
Redirect 301 /docs/mongoid/v9.0/interact-data/transaction/ https://www.mongodb.com/docs/mongoid/v9.0/reference/transactions/
Redirect 301 /docs/mongoid/v9.0/whats-new/ https://www.mongodb.com/docs/mongoid/v9.0/release-notes/mongoid-9.0/
Redirect 301 /docs/mongoid/v9.0/code-documentation/ https://www.mongodb.com/docs/mongoid/v9.0/contributing/code-documentation/
Redirect 301 /docs/mongoid/v9.0/issues-and-help/ https://www.mongodb.com/docs/mongoid/v9.0/contributing/contributing-guidelines/
Redirect 301 /docs/mongoid/v9.0/integrations-tools/external-resources/ https://www.mongodb.com/docs/mongoid/v9.0/ecosystem/
Redirect 301 /docs/mongoid/master/installation/ https://www.mongodb.com/docs/mongoid/master/#quick-start
Redirect 301 /docs/mongoid/master/reference/compatibility/ https://www.mongodb.com/docs/mongoid/master/compatibility/
Redirect 301 /docs/mongoid/master/reference/configuration/ https://www.mongodb.com/docs/mongoid/master/configuration/
Redirect 301 /docs/mongoid/master/reference/rails-integration/ https://www.mongodb.com/docs/mongoid/master/integrations-tools/rails-integration/
Redirect 301 /docs/mongoid/master/tutorials/getting-started-sinatra/ https://www.mongodb.com/docs/mongoid/master/quick-start-sinatra/
Redirect 301 /docs/mongoid/master/tutorials/getting-started-rails7/ https://www.mongodb.com/docs/mongoid/master/quick-start-rails/
Redirect 301 /docs/mongoid/master/tutorials/getting-started-rails6/ https://www.mongodb.com/docs/mongoid/master/quick-start-rails/
Redirect 301 /docs/mongoid/master/tutorials/documents/ https://www.mongodb.com/docs/mongoid/master/data-modeling/documents/
Redirect 301 /docs/mongoid/master/tutorials/common-errors/ https://www.mongodb.com/docs/mongoid/master/
Redirect 301 /docs/mongoid/master/tutorials/automatic-encryption/ https://www.mongodb.com/docs/mongoid/master/security/encryption/
Redirect 301 /docs/mongoid/master/reference/fields/ https://www.mongodb.com/docs/mongoid/master/data-modeling/field-types/
Redirect 301 /docs/mongoid/master/reference/inheritance/ https://www.mongodb.com/docs/mongoid/master/data-modeling/inheritance/
Redirect 301 /docs/mongoid/master/reference/associations/ https://www.mongodb.com/docs/mongoid/master/data-modeling/associations/
Redirect 301 /docs/mongoid/master/reference/validation/ https://www.mongodb.com/docs/mongoid/master/data-modeling/validation/
Redirect 301 /docs/mongoid/master/reference/collection-configuration/ https://www.mongodb.com/docs/mongoid/master/configuration/collection-config/
Redirect 301 /docs/mongoid/master/reference/indexes/ https://www.mongodb.com/docs/mongoid/master/data-modeling/indexes/
Redirect 301 /docs/mongoid/master/reference/sharding/ https://www.mongodb.com/docs/mongoid/master/configuration/sharding/
Redirect 301 /docs/mongoid/master/reference/crud/ https://www.mongodb.com/docs/mongoid/master/interact-data/crud/
Redirect 301 /docs/mongoid/master/reference/queries/ https://www.mongodb.com/docs/mongoid/master/interact-data/specify-query/
Redirect 301 /docs/mongoid/master/reference/text-search/ https://www.mongodb.com/docs/mongoid/master/interact-data/text-search/
Redirect 301 /docs/mongoid/master/reference/aggregation/ https://www.mongodb.com/docs/mongoid/master/interact-data/aggregation/
Redirect 301 /docs/mongoid/master/reference/map-reduce/ https://www.mongodb.com/docs/mongoid/master/interact-data/aggregation/
Redirect 301 /docs/mongoid/master/reference/persistence-configuration/ https://www.mongodb.com/docs/mongoid/master/configuration/persistence-config/
Redirect 301 /docs/mongoid/master/reference/nested-attributes/ https://www.mongodb.com/docs/mongoid/master/interact-data/nested-attributes/
Redirect 301 /docs/mongoid/master/reference/callbacks/ https://www.mongodb.com/docs/mongoid/master/data-modeling/callbacks/
Redirect 301 /docs/mongoid/master/reference/sessions/ https://www.mongodb.com/docs/mongoid/master/interact-data/transaction/
Redirect 301 /docs/mongoid/master/reference/transactions/ https://www.mongodb.com/docs/mongoid/master/interact-data/transaction/
Redirect 301 /docs/mongoid/master/release-notes/upgrading/ https://www.mongodb.com/docs/mongoid/master/whats-new/
Redirect 301 /docs/mongoid/master/release-notes/mongoid-9.0/ https://www.mongodb.com/docs/mongoid/master/whats-new/
Redirect 301 /docs/mongoid/master/contributing/code-documentation/ https://www.mongodb.com/docs/mongoid/master/code-documentation/
Redirect 301 /docs/mongoid/master/contributing/contributing-guidelines/ https://www.mongodb.com/docs/mongoid/master/issues-and-help/
Redirect 301 /docs/mongoid/master/additional-resources/ https://www.mongodb.com/docs/mongoid/master/integrations-tools/external-resources/
Redirect 301 /docs/mongoid/master/ecosystem/ https://www.mongodb.com/docs/mongoid/master/integrations-tools/external-resources/

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for docs-mongoid ready!

Name Link
🔨 Latest commit fd61224
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongoid/deploys/6797fa81dbb422000873409d
😎 Deploy Preview https://deploy-preview-97--docs-mongoid.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few small things, but looks great otherwise!


The driver chooses the first compressor, if you specify multiple, that
is supported by the MongoDB Server.
is supported by the {+mdb-server+}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s:

Suggested change
is supported by the {+mdb-server+}.
is supported by {+mdb-server+}.

or:

Suggested change
is supported by the {+mdb-server+}.
is supported by the {+mdb-server+} deployment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed t your mongodb deployment

``:collection_options`` argument with the ``store_in``
macro. The ``:collection_options`` argument accepts any collection option that
your {+ruby-driver+} and MongoDB server version supports.
your {+ruby-driver+} and {+mdb-server+} version supports.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
your {+ruby-driver+} and {+mdb-server+} version supports.
your {+ruby-driver+} and {+mdb-server+} versions support.


"Client" refers to a host configuration defined under ``clients`` in your
``mongoid.yml`` file. Most applications use a single client named ``default``.
The term client refers to a host configuration defined under
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i: i think you need quotes to designate it as a term, rather than something called a 'term client'. monospace might make more sense depending on context

Suggested change
The term client refers to a host configuration defined under
The term "client" refers to a host configuration defined under

:end-before: # end-embedded-query

You can use the ``pluck()`` projection method to retrieve embedded documents
You can use the ``pluck`` projection method to retrieve embedded documents
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: a lot of our docs include parentheses with method names; is that not standard for ruby?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not standard for ruby

Additional Information
----------------------

To learn more about the field types you can use in {+odm+} models, see
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i: need 'that'

Suggested change
To learn more about the field types you can use in {+odm+} models, see
To learn more about the field types that you can use in {+odm+} models, see

Building a content management application with Sinatra and {+odm+}.

- `How To Create A Ruby API With Sinatra
- `How To Create A {+language+} API With Sinatra
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.mongodb.com/docs/meta/style-guide/style/titles-and-headings/

Suggested change
- `How To Create A {+language+} API With Sinatra
- `How To Create a {+language+} API With Sinatra

The time indicated in log entries is the time that the MongoDB
deployment takes to run MongoDB operations in addition to the time taken to
send commands and receive results from the MongoDB Server. It does
send commands and receive results from the {+mdb-server+}. It does
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
send commands and receive results from the {+mdb-server+}. It does
send commands and receive results from {+mdb-server+}. It does

or:

Suggested change
send commands and receive results from the {+mdb-server+}. It does
send commands and receive results from the {+mdb-server+} deployment. It does

@rustagir rustagir merged commit ae1b978 into mongodb:standardized Jan 27, 2025
5 checks passed
rustagir added a commit that referenced this pull request Jan 28, 2025
* DOCSP-42732: qs

* fix

* wip

* remove action

* NR suggestion

* DOCSP-42732: qs download

* wip

* adapt for sinatra

* vale fix

* snooty landing page

* MW PR fixes 1

* DOCSP-42733: atlas prep qs

* MW PR fixes 1

* DOCSP-42735: configure cxn

* small fix - vale

* JS PR fixes 1

* DOCSP-44008: read/write sinatra quickstart

* fixes

* NR PR fixes 1

* DOCSP-43961: rails qs

* vale

* ordering

* small fix

* MW PR fixes 1

* small fixes

* MW PR fixes 2

* DOCSP-44647: add to existing app

* fix vale action

* vale fixes

* depth

* MW PR fixes 1

* fixes

* DOCSP-42745: interact with data drawer

* tags

* fix vale action

* remove extra word

Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>

* DOCSP-42753: specify query part 1

* vale

* title

* code edits

* MW PR fixes 2

* DOCSP-44849: modify results

* vale

* JS PR fixes 1

* fix

* fix

* list fixes

* MW PR fixes 1

* DOCSP-44954: scoping

* add landing page

* link

* vale

* highlighting

* DOCSP-44821: specify a query pt 2

* MR PR fixes 1

* wip

* wip

* wip

* small fixes

* DOCSP-42767 Aggregation (#57)

* DOCSP-42774: transactions

* vale

* link text

* MW PR fixes 1

* MR PR fixes 1

* DOCSP-45306: model data drawer

* DOCSP-45330: inheritance (WIP)

* MR PR fixes 2

* try using roles

* wip

* vale

* add label

* fixes

* fix

* small fixes - MW

* DOCSP-45358: documents

* fix

* wip

* wip

* DR tech review 1

* page fmt

* page fmt

* SA PR fixes 1

* MR PR fixes 1

* DR small fix

Co-authored-by: Dmitry Rybakov <160598371+comandeo-mongo@users.noreply.github.com>

* DOCSP-45360: nested attributes (#71)

* DOCSP-45360: nested attributes

* vale + fixes

* fixes

* NR PR fixes 1

* DOCSP-45362: text search (#72)

* DOCSP-45362: text search

* wip

* vale

* MM PR fixes 1

* DOCSP-45436 Field Behaviors page (#68)

* DOCSP-45363: validation (#73)

* DOCSP-45363: validation

* keywords

* wip

* SA PR fixes 1

* DOCSP-44794 Field Types (#69)

* DOCSP-45357 Sharding Configuration (#76)

* DOCSP-42762: Indexes (#74)

* DOCSP-45367 Associations pt. 1 (#79)

* DOCSP-45368: Persistence Configuration (#77)

* DOCSP-45361: callbacks (#75)

* DOCSP-45361: callbacks

* wip

* wip

* wip

* NR PR fixes 1

* DOCSP-45364: CRUD pt 1 (#81)

* checkpoint

* checkpoint 2

* woohoo first pass

* indent

* Edits

* updates

* vale chekcs

* RR PR fixes 1

* fix code file

* code fixes

* RM PR fixes 1

---------

Co-authored-by: rustagir <rea.rustagi@mongodb.com>

* DOCSP-45110: queries subsections (#80)

* DOCSP-45110: queries misc sections

* wip:

* vale

* MR PR fixes 1

* GM PR fixes 1

* DOCSP-46072 Associations part 2 (#82)

* DOCSP-46394: CRUD remaining sections (#83)

* DOCSP-46394: CRUD remaining sections

* vale fixes

* JS PR fixes 1

* DOCSP-46213: bump to rails 8 and remove old tuts (#84)

* DOCSP-45356: i&h + code doc (#86)

* DOCSP-45356: i&h + code doc

* remove contributing

* vale fixes

* link fix

* vale fixes + RM comment

* DOCSP-42770: release notes/whats new (#87)

* DOCSP-42770: release notes/whats new

* fixes

* fixes

* DOCSP-42773: api links (#88)

* DOCSP-42773: api links

* fix

* link fixes

* DOCSP-42772: compatibility (#90)

* DOCSP-42772: compatibility

* small fix

* small fix

* SA PR fixes 1

* delete files for old build system

* column width adjustment

* DOCSP-45366 Encryption (#89)

* DOCSP-42741: config pages (#91)

* DOCSP-42741: config

* wip

* wip

* some vale fixes

* RM PR fixes 1

* small fix

* DOCSP-46555: rails integration (#92)

* wip

* DOCSP-46555: rails integration

* RM PR fixes 1

* DOCSP-45359 External Resources (#94)

* add additional resources page

* edits

* feedback

* DOCSP-42743 Collection config (#95)

* DOCSP-42730: landing page (#96)

* DOCSP-42730: landing page

* MW PR fixes 1

* small fix

* small fix

* small fix

* DOCSP-46121: cleanup (#97)

* cleanup

* copy compat action

* redirects

* MW PR fixes 1

* add index section

* change vs in redirects

---------

Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>
Co-authored-by: Dmitry Rybakov <160598371+comandeo-mongo@users.noreply.github.com>
Co-authored-by: Maya Raman <maya.raman19@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants