[DOCS-135] New Documentation Review: Tutorials/Process Guides Created: 22/Feb/12  Updated: 30/Oct/23  Due: 01/Mar/12  Resolved: 05/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: siddharth.singh@10gen.com
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, 2 days 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 contain tutorials, 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/tutorial/install-mongodb-on-redhat-centos-or-fedora-linux.rst
  • docs/source/tutorial/install-mongodb-on-os-x.rst
  • docs/source/tutorial/install-mongodb-on-debian-or-ubuntu-linux.rst
  • docs/source/tutorial/install-mongodb-on-linux.rst
  • docs/source/tutorial/change-oplog-size.rst
  • docs/source/tutorial/expand-replica-set.rst
  • docs/source/tutorial/deploy-replica-set.rst
  • docs/source/tutorial/convert-replica-set-to-replicated-shard-cluster.rst
  • docs/source/tutorial/deploy-geographically-distributed-replica-set.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 Sam Kleinman (Inactive) [ 05/Mar/12 ]

Thanks!

Comment by auto [ 05/Mar/12 ]

Author:

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

Message: DOCS-135 merge siddharth's comments and suggestions
Branch: master
https://github.com/mongodb/docs/commit/b28f5be3cc5f2d99cd56b4ace6b9601697447544

Comment by auto [ 05/Mar/12 ]

Author:

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

Message: DOCS-135 editing installation and tutorials with siddharth's comments.
Branch: master
https://github.com/mongodb/docs/commit/5038c71052fb6c0443f45496550fdd2d790cdcc5

Comment by siddharth.singh@10gen.com [ 05/Mar/12 ]

https://github.com/mongodb/docs/pull/6

Comment by auto [ 26/Feb/12 ]

Author:

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

Message: DOCS-135 editing and clarifying style of os x installation guide based on feedback from tylerbrock
Branch: master
https://github.com/mongodb/docs/commit/7351ca0ac67699917066069f61b0a992609ecf8e

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

Siddarth,

Tyler Brock is looking at the OS X Installation guide, and adding a bit more instructions around the Homebrew/MacPorts paths and details that the initial version was lacking. I'll keep you posted on this as we update the document, but I don't think this should impact things for you much.

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