[DOCS-144] New Documentation Review: Glossary Created: 22/Feb/12  Updated: 30/Oct/23  Due: 01/Mar/12  Resolved: 01/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: Kyle Banker
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, 6 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 is the path the of the glossary file, 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/glossary.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 [ 01/Mar/12 ]

Author:

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

Message: DOCS-144 glossary revisions and post-review cleanup
Branch: master
https://github.com/mongodb/docs/commit/013be552d3ce8e19c14d7c1817139dbed2c098a5

Comment by auto [ 01/Mar/12 ]

Author:

{u'login': u'banker', u'name': u'Kyle Banker', u'email': u'kylebanker@gmail.com'}

Message: DOCS-144 glossary review part deux
Branch: master
https://github.com/mongodb/docs/commit/0b21a38c7ab855ffed9f70c4db79e856803db7dc

Comment by auto [ 27/Feb/12 ]

Author:

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

Message: DOCS-144: glossary changes editing and refactoring
Branch: master
https://github.com/mongodb/docs/commit/f9c08e51edeb82ab138f69d3e8342208651661f6

Comment by auto [ 26/Feb/12 ]

Author:

{u'login': u'banker', u'name': u'Kyle Banker', u'email': u'kylebanker@gmail.com'}

Message: DOCS-144: glossary review part 1
Branch: master
https://github.com/mongodb/docs/commit/1ef5b828326651713f9173e9bbff43b962fe5d94

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