DOCSP-42741: config pages #91

rustagir · 2025-01-17T18:02:26Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-42741
Staging - multiple pages from https://deploy-preview-91--docs-mongoid.netlify.app/configuration/

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?

netlify · 2025-01-17T18:02:46Z

✅ Deploy Preview for docs-mongoid ready!

Name	Link
🔨 Latest commit	`4f470ac`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-mongoid/deploys/679013aa2737120008891230
😎 Deploy Preview	https://deploy-preview-91--docs-mongoid.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

…OCSP-42741-config

rachel-mack

Some minor adjustments:

rachel-mack · 2025-01-21T18:52:48Z

source/configuration/app-config.txt

+- ``false`` (*default*): {+odm+} uses ``Time.zone`` to set the time
+  zone of time values are loaded from database.


There's a few ways this could be corrected. This is my best guess:

Suggested change

- ``false`` (*default*): {+odm+} uses ``Time.zone`` to set the time

zone of time values are loaded from database.

- ``false`` (*default*): {+odm+} uses ``Time.zone`` to set the time

zone as time values are loaded from the database.

rachel-mack · 2025-01-21T18:57:50Z

source/configuration/app-config.txt

+To set TLS context hooks, add a ``Proc`` to the ``Mongo.tls_context_hooks``
+array, which can be done in an initializer. The following example adds a hook


Seems a bit awkward:

Suggested change

To set TLS context hooks, add a ``Proc`` to the ``Mongo.tls_context_hooks``

array, which can be done in an initializer. The following example adds a hook

To set TLS context hooks, add a ``Proc`` to the ``Mongo.tls_context_hooks``

array. This can be done in an initializer. The following example adds a hook

rachel-mack · 2025-01-21T19:01:25Z

source/configuration/app-config.txt

+- `Zstandard <https://facebook.github.io/zstd/>`__: To use ``zlib``
+  compression, you must install the  `zstd-ruby
+  <https://rubygems.org/gems/zstd-ruby>`__ library.


Move this to the top of the list since it's our recommendation:

Suggested change

- `Zstandard <https://facebook.github.io/zstd/>`__: To use ``zlib``

compression, you must install the `zstd-ruby

<https://rubygems.org/gems/zstd-ruby>`__ library.

- `Zstandard <https://facebook.github.io/zstd/>`__ (recommended): To use ``zlib``

compression, you must install the `zstd-ruby

<https://rubygems.org/gems/zstd-ruby>`__ library.

- produces the highest compression with the same CPU consumption

rachel-mack · 2025-01-21T19:27:23Z

source/configuration/app-config.txt

+is supported by the MongoDB Server. We recommend using the ``zstd``
+compressor because it produces the highest compression at the same CPU
+consumption compared to the other compressors.


Add this recommendation into the list above.

Suggested change

is supported by the MongoDB Server. We recommend using the ``zstd``

compressor because it produces the highest compression at the same CPU

consumption compared to the other compressors.

is supported by the MongoDB Server.

rachel-mack · 2025-01-21T19:44:41Z

source/configuration/forking-server-config.txt

+Use the ``after_fork`` hook to reconnect clients in the workers. Use
+the ``before_fork`` hook to close clients in the parent process. To


Nit: I would just reverse these two sentences:

Suggested change

Use the ``after_fork`` hook to reconnect clients in the workers. Use

the ``before_fork`` hook to close clients in the parent process. To

Use the ``before_fork`` hook to close clients in the parent process. Use the ``after_fork`` hook to reconnect clients in the workers. To

rachel-mack · 2025-01-21T19:48:54Z

source/configuration/logging-config.txt

+To configure either {+odm+} or driver logger differently from the Rails
+logger, use an initializer as shown in the following code:


Suggested change

To configure either {+odm+} or driver logger differently from the Rails

logger, use an initializer as shown in the following code:

To configure either the {+odm+} or driver logger differently from the Rails

logger, use an initializer as shown in the following code:

rachel-mack · 2025-01-21T19:52:20Z

source/configuration/query-cache-config.txt

+     include Mongo::QueryCache::Middleware::ActiveJob
+   end
+
+You can also for a specific job class, as shown in the following code:


Suggested change

You can also for a specific job class, as shown in the following code:

You can also enable it for a specific job class, as shown in the following code:

* 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Jordan Smith <[email protected]> Co-authored-by: Dmitry Rybakov <[email protected]> Co-authored-by: Maya Raman <[email protected]>

DOCSP-42741: config

594a248

rustagir added 2 commits January 17, 2025 13:17

Merge branch 'standardized' of github.com:mongodb/docs-mongoid into D…

7e6ca85

…OCSP-42741-config

wip

799b9a9

rustagir changed the base branch from master to standardized January 17, 2025 20:24

rustagir changed the title ~~Docsp 42741 config~~ DOCSP-42741: config pages Jan 17, 2025

rustagir added 2 commits January 17, 2025 15:27

wip

65fa22a

some vale fixes

5816694

rachel-mack approved these changes Jan 21, 2025

View reviewed changes

rustagir added 3 commits January 21, 2025 16:26

merge upstream

eaaa203

RM PR fixes 1

b723696

small fix

4f470ac

rustagir merged commit c2f35b7 into mongodb:standardized Jan 21, 2025
3 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-42741: config pages #91

DOCSP-42741: config pages #91

Uh oh!

rustagir commented Jan 17, 2025 •

edited

Loading

Uh oh!

netlify bot commented Jan 17, 2025 •

edited

Loading

Uh oh!

rachel-mack left a comment

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rustagir Jan 21, 2025

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rachel-mack Jan 21, 2025

Uh oh!

rustagir Jan 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		- ``false`` (default): {+odm+} uses ``Time.zone`` to set the time
		zone of time values are loaded from database.

		To set TLS context hooks, add a ``Proc`` to the ``Mongo.tls_context_hooks``
		array, which can be done in an initializer. The following example adds a hook

		Use the ``after_fork`` hook to reconnect clients in the workers. Use
		the ``before_fork`` hook to close clients in the parent process. To

	Use the ``after_fork`` hook to reconnect clients in the workers. Use
	the ``before_fork`` hook to close clients in the parent process. To
	Use the ``before_fork`` hook to close clients in the parent process. Use the ``after_fork`` hook to reconnect clients in the workers. To

		To configure either {+odm+} or driver logger differently from the Rails
		logger, use an initializer as shown in the following code:

	You can also for a specific job class, as shown in the following code:
	You can also enable it for a specific job class, as shown in the following code:

DOCSP-42741: config pages #91

DOCSP-42741: config pages #91

Uh oh!

Conversation

rustagir commented Jan 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

netlify bot commented Jan 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-mongoid ready!

Uh oh!

rachel-mack left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rustagir commented Jan 17, 2025 •

edited

Loading

netlify bot commented Jan 17, 2025 •

edited

Loading