[DOCS-4041] Configuration File Options Descriptions need harmonization Created: 15/Sep/14  Updated: 30/Oct/23  Resolved: 30/Apr/15

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Major - P3
Reporter: Michael Paik Assignee: Allison Reinheimer Moore
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 8 years, 41 weeks, 6 days ago

 Description   

http://docs.mongodb.org/manual/reference/configuration-options/ has inconsistent diction in the first sentence of each setting.

Text should be descriptive, e.g. 'The maximum number of simultaneous connections that mongos or mongod will accept' rather than active 'Specifies the TCP port on which the MongoDB instance listens for client connections. This latter should read 'The TCP port on which the MongoDB instance listens for client connections.'



 Comments   
Comment by Githook User [ 30/Apr/15 ]

Author:

{u'username': u'schmalliso', u'name': u'Allison Moore', u'email': u'allison.moore@10gen.com'}

Message: DOCS-4041 & DOCS-5183: config file verbage & unix-only note

  • Harmonizes config file verbage so it's less weird when inherited
    by both mongodb-options and conf-options
  • Emphasizes that unix socket command is unix-only.

DOCS-5183: notes that unixDomain options are Unix-specific

updated with Kay's edits

Signed-off-by: kay <kay.kim@10gen.com>
Branch: master
https://github.com/mongodb/docs/commit/15e7e923c5cd4a3f181b8d8184420b2dfdd9b97e

Comment by Allison Reinheimer Moore [ 10/Apr/15 ]

Branch for reviewing (it's easiest to review by building locally): https://github.com/schmalliso/docs-mongodb/tree/harmonization

Generated at Thu Feb 08 07:47:04 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.