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

[Post 3.2 release] - SDK DOC Improvements

    XMLWordPrintable

Details

    • Epic
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • sdk3.2-backlog
    • None
    • [Post 3.2 release] - SDK DOC Improvements
    • To Do
    • 1

    Description

      After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

      Some ideas:

      • Adding more information in concept docs to help application developers
      • Extracting any leftover examples from the .adoc files into separate code files
      • Fixing any lower priority bugs in the docs

      Attachments

        Issue Links

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

          Activity

            maria.shodunke Maria Shodunke created issue -
            maria.shodunke Maria Shodunke made changes -
            Field Original Value New Value
            Summary After SDK 3.2 release we should look at areas of the docs that could benefit from improvements [Post 3.2 release]- SDK DOC Improvements
            maria.shodunke Maria Shodunke made changes -
            Description We should look at areas of the 3.2 SDK docs that we can improve:

            Some ideas:

            - Concept docs

            - Examples that can be extracted into code files
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Examples that can be extracted into code files
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Examples that can be extracted into code files
            After the SDK 3.2 releases we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Examples that can be extracted into code files
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 releases we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Examples that can be extracted into code files
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Examples that can be extracted into code files
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-8777 [ 165485 ]
            maria.shodunke Maria Shodunke made changes -
            Summary [Post 3.2 release]- SDK DOC Improvements [Post 3.2 release] - SDK DOC Improvements
            maria.shodunke Maria Shodunke made changes -
            Epic Name [Post 3.2 release]- SDK DOC Improvements [Post 3.2 release] - SDK DOC Improvements
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Examples that can be extracted into code files
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Outstanding examples that can be extracted into code files
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Concept docs

             - Outstanding examples that can be extracted into code files
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             -  Extracting any leftover examples from the .adoc files into separate code files
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             -  Extracting any leftover examples from the .adoc files into separate code files
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             -  Extracting any leftover examples from the .adoc files into separate code files


             - Fixing any lower priority bugs in the docs for 3.2
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             -  Extracting any leftover examples from the .adoc files into separate code files


             - Fixing any lower priority bugs in the docs for 3.2
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             -  Extracting any leftover examples from the .adoc files into separate code files

             - Fixing any lower priority bugs in the docs
            maria.shodunke Maria Shodunke made changes -
            Description After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             -  Extracting any leftover examples from the .adoc files into separate code files

             - Fixing any lower priority bugs in the docs
            After the SDK 3.2 release we should look at areas of the docs that could benefit from improvements.

            Some ideas:
             - Adding more information in concept docs to help application developers

             - Extracting any leftover examples from the .adoc files into separate code files

             - Fixing any lower priority bugs in the docs
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8784 [ 165575 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8787 [ 165587 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8805 [ 165872 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-7969 [ 148605 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-7152 [ 135077 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-4925 [ 99879 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8829 [ 166278 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-7745 [ 145444 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8844 [ 166360 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8812 [ 165968 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8797 [ 165806 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8809 [ 165904 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8358 [ 155002 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8517 [ 158974 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8851 [ 166432 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8854 [ 166439 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8855 [ 166440 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8856 [ 166441 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8857 [ 166442 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8858 [ 166443 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8859 [ 166444 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8860 [ 166445 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8873 [ 166600 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8874 [ 166601 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7105 [ 134561 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-5314 [ 104183 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-5316 [ 104186 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8401 [ 156026 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8129 [ 151438 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8026 [ 149080 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7990 [ 148814 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7987 [ 148752 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7980 [ 148677 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7963 [ 148443 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7979 [ 148673 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-6700 [ 126941 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8721 [ 164763 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-6953 [ 131444 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8673 [ 163607 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8636 [ 162863 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8507 [ 158610 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7945 [ 148297 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7967 [ 148549 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8880 [ 166636 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8884 [ 166679 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-7429 [ 139694 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child NCBC-2719 [ 145544 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-7147 [ 134998 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-6912 [ 130254 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-1873 [ 59810 ]
            richard.smedley Richard Smedley made changes -
            Link This issue relates to DOC-7077 [ DOC-7077 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8896 [ 167010 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8897 [ 167012 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8898 [ 167014 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8899 [ 167015 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8900 [ 167017 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8526 [ 159294 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8901 [ 167020 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child SCBC-272 [ 145550 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8903 [ 167029 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8904 [ 167030 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8905 [ 167031 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-7297 [ 137928 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8892 [ 166955 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8906 [ 167048 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8907 [ 167051 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8912 [ 167105 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8913 [ 167112 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-5965 [ 114009 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8920 [ 167271 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-5317 [ 104187 ]
            richard.smedley Richard Smedley made changes -
            Link This issue relates to DOC-7966 [ DOC-7966 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8934 [ 167623 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8942 [ 167725 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child CCBC-1441 [ 167698 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8949 [ 167887 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-5209 [ 102935 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8951 [ 167960 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-8952 [ 167976 ]
            maria.shodunke Maria Shodunke made changes -
            Link This issue is cloned by DOC-8954 [ DOC-8954 ]
            maria.shodunke Maria Shodunke made changes -
            Link This issue is cloned by DOC-8954 [ DOC-8954 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-8954 [ 167979 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8937 [ 167686 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8250 [ 152955 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8969 [ 168205 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8970 [ 168226 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-8975 [ 168334 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-9007 [ 169004 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-9010 [ 169038 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-9011 [ 169048 ]
            richard.smedley Richard Smedley made changes -
            Link This issue relates to DOC-8697 [ DOC-8697 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8476 [ 157907 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8148 [ 151577 ]
            richard.smedley Richard Smedley made changes -
            Link This issue relates to DOC-8196 [ DOC-8196 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-9032 [ 169278 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-5801 [ 111668 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child NCBC-2957 [ 169524 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9053 [ 169528 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-9087 [ 170289 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9174 [ 171394 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-9234 [ 172337 ]
            maria.shodunke Maria Shodunke made changes -
            Epic Child DOC-9234 [ 172337 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9227 [ 172240 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9224 [ 172190 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9137 [ 170825 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9248 [ 172736 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9165 [ 171292 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9254 [ 172959 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9279 [ 173295 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9281 [ 173430 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9284 [ 173538 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-9329 [ 175158 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-9350 [ 175767 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9358 [ 175899 ]
            hakim.cassimally Hakim Cassimally made changes -
            Epic Child DOC-9355 [ 175827 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8809 [ 165904 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-7147 [ 134998 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-8892 [ 166955 ]
            richard.smedley Richard Smedley made changes -
            Epic Child DOC-4925 [ 99879 ]

            People

              maria.shodunke Maria Shodunke
              maria.shodunke Maria Shodunke
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty