[DOCS-137] New Documentation Review: Backups and Importing/Exporting Documents Created: 22/Feb/12  Updated: 30/Oct/23  Due: 01/Mar/12  Resolved: 05/Dec/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: Scott Hernandez (Inactive)
Resolution: Done Votes: 0
Labels: review
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to DOCS-156 Reorganize Backup Documentation into ... Closed
Participants:
Days since reply: 11 years, 11 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 backups and importing/exporting data, 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/administration/backups.rst
  • docs/source/administration/import-export.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/Dec/12 ]

went through rest of backups document with richard a couple of weeks ago and he gave a thumbs up on backups section.

everything else Kyle and Dan P went through as far as I know.

Comment by Sam Kleinman (Inactive) [ 03/Oct/12 ]

We talked about this in person a few weeks ago, but it would be most helpful if you could look at the following document and make sure that there aren't problems with it, in advance of migrating the wiki document to the manual.

http://docs.mongodb.org/manual/administration/backups/

Comment by Daniel Pasette (Inactive) [ 16/Mar/12 ]

need to finish last part of file.

Comment by auto [ 16/Mar/12 ]

Author:

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

Message: DOCS-137: merge backup documentation editing and clarification.
Branch: master
https://github.com/mongodb/docs/commit/b537f2376d57d271f94dbfec5db49f7fe7b60007

Comment by auto [ 16/Mar/12 ]

Author:

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

Message: DOCS-137 backups edits/review checkpoint
Branch: master
https://github.com/mongodb/docs/commit/5d3004e1456fa7ccee0df46129f9e273d250996d

Comment by auto [ 16/Mar/12 ]

Author:

{u'login': u'monkey101', u'name': u'Dan Pasette', u'email': u'dan@10gen.com'}

Message: DOCS-137. 2nd checkpoint on backups.rst
Branch: master
https://github.com/mongodb/docs/commit/ed399adf9f18d17164f1b614a21882de816c2e89

Comment by auto [ 15/Mar/12 ]

Author:

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

Message: DOCS-137 cross refing type fidelity.
Branch: master
https://github.com/mongodb/docs/commit/0ca46148bf6d8a08fb36cce848ec5cf9a6502816

Comment by auto [ 15/Mar/12 ]

Author:

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

Message: DOCS-137: addting type fidelity section to import/export guide
Branch: master
https://github.com/mongodb/docs/commit/7c6204e85d5028ec04744b7b37336beba8fd6b80

Comment by auto [ 14/Mar/12 ]

Author:

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

Message: DOCS-137 Merge commits and review/edits from dan p.
Branch: master
https://github.com/mongodb/docs/commit/04051307fcc28d3448b6156b353563af502d46e2

Comment by auto [ 14/Mar/12 ]

Author:

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

Message: DOCS-137 editing in response to first pass commit
Branch: master
https://github.com/mongodb/docs/commit/cf69619372122599a96bcfc0b043d7704b40fed2

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