[DOCS-335] Error Message Reference Created: 13/Jul/12  Updated: 30/Oct/23  Resolved: 18/May/16

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

Type: Tracking Priority: Major - P3
Reporter: Barrie Segal Assignee: Unassigned
Resolution: Won't Fix Votes: 1
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Depends
Duplicate
is duplicated by DOCS-83 Document mongod error codes. Closed
is duplicated by DOCS-1519 Publish list of assertion / error cod... Closed
is duplicated by DOCS-1800 type not supported for appendMinElem... Closed
is duplicated by DOCS-2424 Comment on: "about/contributors/error... Closed
is duplicated by DOCS-4617 Document mongod error codes Closed
Gantt Dependency
has to be done before DOCS-1124 Remove about/contributors/error-codes... Closed
Related
related to DOCS-1519 Publish list of assertion / error cod... Closed
related to DOCS-476 Document startup warnings in a separa... Closed
related to DOCS-2224 Comment on: "about/contributors/error... Closed
is related to JAVA-623 Improve error code documentation Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCS-83 Document mongod error codes. Sub-task Closed Ed Costello  
DOCS-19 MongoDB exit code reference Sub-task Closed Ed Costello  
DOCS-425 "Could not initialize cursor across a... Sub-task Closed Bob Grabar  
DOCS-440 ""errmsg" : "move failed"" Sub-task Closed  
DOCS-928 Documentation around assertion failur... Sub-task Closed  
DOCS-1158 Document RS102 error message Sub-task Closed  
DOCS-1413 Need a better explanation for the err... Sub-task Closed  
DOCS-2029 Document error 16535 Sub-task Closed  
Participants:
Days since reply: 7 years, 39 weeks ago

 Description   

The documentation should contain a reference for any error code a user might be faced with.



 Comments   
Comment by Emmanuel Bernard [ 18/May/16 ]

For what it is worth, +1 on what Oliver said. Mapping framework and actual suer code defensive will want error code numbers.

Comment by Kay Kim (Inactive) [ 18/May/16 ]

Fair enough and thanks for the input. Definitely will revisit the decision. We do currently have the error codes pages, and after we plan the best course of action for programmatically providing a complete code/message reference, can prioritize the project and do it in one fell swoop.

Comment by Oliver Gierke [ 18/May/16 ]

I think that's a very, very bad idea. Human readers browsing a documentation is one thing but if I write some client software that interprets these errors (like e.g. here) I don't want to rely on looking for a message that could possibly change, internationalized at some point or the like.

Comment by Kay Kim (Inactive) [ 18/May/16 ]

I'm going to close this because generally, we try to avoid documenting error codes – since they should include an err message that explains what the code is. We can revisit if we feel that the likelihood of error codes changing would be small.

Comment by Anne Moroney [ 03/Jun/14 ]

I'm curious which part of this work is the duplicate of ;
DOCS-1800 type not supported for appendMinElementForType" , "code" : 10061
Also, fyi, I added some detail to that ticket just in case it might help someone.

Comment by auto [ 22/Aug/12 ]

Author:

{u'date': u'2012-08-22T13:17:50-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}

Message: merge: DOCS-335 initial
Branch: master
https://github.com/mongodb/docs/commit/d42303d6d8c8ee43fddfbb50de8cf8144b6db6ea

Comment by auto [ 20/Aug/12 ]

Author:

{u'date': u'2012-08-20T14:38:25-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}

Message: merge: DOCS-335
Branch: master
https://github.com/mongodb/docs/commit/2176bca29190b86498e07e7533a39e49399d0c3e

Comment by auto [ 20/Aug/12 ]

Author:

{u'date': u'2012-08-20T13:54:37-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}

Message: merge: DOCS-335
Branch: master
https://github.com/mongodb/docs/commit/8bc8f8301d1123b0b67f7c40bab405abb0039f20

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