Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-2802

Documentation of Error codes, starting with XATTR

    XMLWordPrintable

Details

    Description

      After discussion with the Docs team, this ticket is just for the SDK Error codes.
      Server will be covered later (in another issue) when resources are available.

      As part of DOC-2388, Matt Ingenthron wrote:

       

      This issue would be done when Couchbase Server documentation has a section that covers:
       
      * Error codes including the hex value, text returned, and a description of the error condition 

      As we do not give these details in depth for any area of Couchbase in the documentation, I've put this in a new ticket (closing the old one) so interested parties can:

      1. Discuss the depth of detail we should cover error codes
      2. Cover all of the components that should be covered (for consistency)
      3. Suggest best practices for workflow and process to get the information to the docs team.

      Thank you

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            richard.smedley Richard Smedley added a comment - - edited

            Detailed documentation of error codes was raised as a concern (for XATTR) in DOC-2388.

            richard.smedley Richard Smedley added a comment - - edited Detailed documentation of error codes was raised as a concern (for XATTR) in DOC-2388 .

            The N1QL pages have the error codes - but nothing further to answer "what next?"

            We need to first look at generating the codes for each feature automatically, from the source.

            Then we need to look at adding useful information for fixing common - and uncommon - error messages.

             

            richard.smedley Richard Smedley added a comment - The N1QL pages have the error codes - but nothing further to answer "what next?" We need to first look at generating the codes for each feature automatically, from the source. Then we need to look at adding useful information for fixing common - and uncommon - error messages.  

            This is being addressed as part of the SDK 3.0 Docs rewrite.

            richard.smedley Richard Smedley added a comment - This is being addressed as part of the SDK 3.0 Docs rewrite.

            Removing MH tag, as just covering SDK Error Codes now.

            richard.smedley Richard Smedley added a comment - Removing MH tag, as just covering SDK Error Codes now.

            SDK team are in the process of agreeing error codes for SDK 3.0
            Will be starting to document them as soon as that task is complete.

            richard.smedley Richard Smedley added a comment - SDK team are in the process of agreeing error codes for SDK 3.0 Will be starting to document them as soon as that task is complete.

            The Error Codes RFC for SDK 3.0 is nearly stable,
            and the SDKs are implementing the codes -
            when all is agreed, they will be documented in a reference doc for SDK 3.0 - tracked by DOC-5208.

            It's unlikely that resources will be available to backport this 3.0 doc to the 2.0 SDKs,
            so I am closing this ticket.

            Please re-open if you disagree on the priority of this.

            NOTE extent of error code reference documentation in the rest of Couchbase is still under discussion.

            richard.smedley Richard Smedley added a comment - The Error Codes RFC for SDK 3.0 is nearly stable, and the SDKs are implementing the codes - when all is agreed, they will be documented in a reference doc for SDK 3.0 - tracked by  DOC-5208 . It's unlikely that resources will be available to backport this 3.0 doc to the 2.0 SDKs, so I am closing this ticket. Please re-open if you disagree on the priority of this. NOTE extent of error code reference documentation in the rest of Couchbase is still under discussion.

            People

              richard.smedley Richard Smedley
              richard.smedley Richard Smedley
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty