[DOCS-2537] Update documentation for non-internal commands Created: 15/Jan/14  Updated: 17/Feb/15  Resolved: 04/Feb/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: mongodb-2.6
Fix Version/s: v1.3.0, mongodb-2.6

Type: Improvement Priority: Minor - P4
Reporter: Andreas Nilsson Assignee: Sam Kleinman (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 10 years, 2 weeks, 1 day ago

 Description   

The following commands are labeled internal in the documentation but are considered regular commands.

captrunc, dbHash, diagLogging, getShardVersion

These commands should be documented properly and any references to internal be removed.



 Comments   
Comment by Githook User [ 04/Feb/14 ]

Author:

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

Message: DOCS-2537: edit internal markers on some commands
Branch: master
https://github.com/mongodb/docs/commit/71b03f642e002a2d2cc740cbac2124511b317cfa

Comment by Andreas Nilsson [ 21/Jan/14 ]

Ok after discussion with Scott and Andy we decided that these commands should be reasonably documented but not extensively.

They should also be marked as "used for diagnosis", "not part of the stable user interfacing API" or something else indicating that we are not guaranteeing forwards compatibility with these commands.

Comment by Andreas Nilsson [ 16/Jan/14 ]

scotthernandez I am not sure I agree that there should be two different kinds of internal. Non of the two categories above classify as internal to me. It's different kinds of external.

I think there is a lot of confusion regarding the status of many commands that could be alleviated if we were more clear internally and within our docs.

Comment by Scott Hernandez (Inactive) [ 16/Jan/14 ]

While these can be used by uses they are still internal commands not meant for the user to run normally and things we consider part of the plumbing not features. Andreas, please remember there is a different between internal wrt/auth(z) and internal wrt/docs-and-users.

Are you asking these be listed as non-internal on some list relating to security or documented like other "user" commands? Please clarify the title/descr. accordingly.

Comment by Greg Studer [ 16/Jan/14 ]

WriteBacksQueued is internal, and only should be used by mongos to determine if a shard is eligible as a donor or receiver for chunk migration.

getShardVersion can be doc'd though, there are diagnostics in there.

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