[DOCS-140] New Documentation Review: Runtime Configuration Created: 22/Feb/12  Updated: 30/Oct/23  Due: 05/Mar/12  Resolved: 06/Mar/12

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

Type: Task Priority: Major - P3
Reporter: Sam Kleinman (Inactive) Assignee: Michael A. Fiedler
Resolution: Done Votes: 0
Labels: review
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 11 years, 50 weeks ago

 Description   

Before we publish the new documentation it needs some kind of technical review. The goal is to make sure that the documentation doesn't create confusion and/or provide misinformation. Any feedback big or small is very welcome, but the main purpose of this review is to make sure that there are no gaping oversights.

The best way to proceed will be to fork the <https://github.com/mongodb/docs> repository to your own github accounts, make annotations directly in the file (or make changes if you think that will be easier) and then issue a pull request and I'll merge this content into the docs repo and make the indicated changes. All of the documentation source reStructured Text. Don't worry about the specific formatting, if you're not familiar: I can answer any questions and attend to maintaining correct formatting.

While it may be tempting to make changes and do more line-by-line editing, Kyle and I have found that it may be more efficient to just add lines that begin with "TODO " and instruction between the relevant paragraphs with instructions on the required change or changes. You can also leave comments about more global issues on this ticket (or in line whatever is easier for you. If needed, I will follow up with questions as I make the revisions.

Below are the paths of several files in the repository that address and support runtime configuration, and I think you'd be the best person to do this review at this time. If you won't have time to get to this, please let us know so we can reassign this ticket.

  • docs/source/reference/mongod.rst
  • docs/source/reference/mongos.rst
  • docs/source/reference/configuration-options.rst
  • docs/source/administration/configuration.rst

If you want to install Sphinx and build the documents locally you can review the docs (more or less) as they'll appear on the website, feel free. If you're having problems with getting the docs to build, tell me so I can resolve any issue with the build process and help you get setup.

– samk



 Comments   
Comment by auto [ 07/Mar/12 ]

Author:

{u'login': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: Merge commits from Michael's DOCS-140 review branch for the runtime configuration.
Branch: master
https://github.com/mongodb/docs/commit/310ceda8e78b54be48c7f1fce97d0b021943dc82

Comment by auto [ 07/Mar/12 ]

Author:

{u'login': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: editing configuration files in response to comments from DOCS-140
Branch: master
https://github.com/mongodb/docs/commit/e66908d460ce534b7600a119bc270cd974dae41f

Comment by Michael A. Fiedler [ 06/Mar/12 ]

Reviewed.
I've issued a pull request here: https://github.com/mongodb/docs/pull/7

Don't merge it as is.

Comment by Sam Kleinman (Inactive) [ 22/Feb/12 ]

Note that the "configuration-options.rst" file replicates a lot of the documentation in the mongos.rst and mongod.rst. If you read the configuration-options file in some depth, you can do a comparatively cursory pass on the mongod and mongos files and I'll port any/all changes/suggestions from the configuration-options file over to the mongos and mongod files.

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