Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-7420

Developer's Guide should be linked to more prominently from various SDK pages

    Details

      Description

      The various SDK pages, and the SDK docs as well, should probably have prominent links to the Developer's Guide.

      As I understand it, a lot of the common overview of how to develop with Couchbase Server is meant to be in the Developer's Guide, including important best practices and helpful examples. The individual SDK docs are lower level items and specific usage items, but don't really cover general Couchbase Server development that applies to any SDK.

      I think the SDK pages should all feature a prominent link, near the top, to the Developer's Guide. I think they should also include links to specific parts of the Developer's Guide wherever appropriate. This way, a PHP developer, for example, who is looking at the setMulti method documentation, will easily find that we have a whole section on bulk operations in the Developer's Guide.

      Right now, sticking with the PHP example, the only link is at the very bottom of the /develop/php/current page, buried inside some nameless paragraph. Very hard to find, and I doubt most people will read that far.

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

        Activity

        Hide
        mccouch MC Brown (Inactive) added a comment -

        I've added sidebar content to provide better links in the devguide, server and individual client libs.

        Longer term, the links between sections will come out of the new linking and ID mapping system currently in development. I'll add this note to the issues.

        Show
        mccouch MC Brown (Inactive) added a comment - I've added sidebar content to provide better links in the devguide, server and individual client libs. Longer term, the links between sections will come out of the new linking and ID mapping system currently in development. I'll add this note to the issues.
        Hide
        kzeller kzeller added a comment -

        Hi Tim,

        Sadly I had added a sentence and link to the developer's guide in Drupal to each and every SDK landing page as part of 2.0. It was here for instance:

        http://www.couchbase.com/develop/java/current

        In the section headers with this type content:

        "The Java client library provides fast access to documents in Couchbase Server 2.0. With JSON documents and Couchbase server 2.0 you have new ways to index and query data stored in the cluster through views. These view(s) can be accessed using the newly defined View and Query objects.

        You can provide different perspsectives to the data. For example, on the sample beer data, you can sort by category, ABV and so on depending on your taste!"

        Someone (or each SDK team member) has removed these links and therefore I will not recreate this work. The issue however will be resolved in the new site launching 3/18/2013 where the Developer Guide appears in a top level navigation that appears at all times regardless of what guide you are in. I hope that helps.

        Karen

        Show
        kzeller kzeller added a comment - Hi Tim, Sadly I had added a sentence and link to the developer's guide in Drupal to each and every SDK landing page as part of 2.0. It was here for instance: http://www.couchbase.com/develop/java/current In the section headers with this type content: "The Java client library provides fast access to documents in Couchbase Server 2.0. With JSON documents and Couchbase server 2.0 you have new ways to index and query data stored in the cluster through views. These view(s) can be accessed using the newly defined View and Query objects. You can provide different perspsectives to the data. For example, on the sample beer data, you can sort by category, ABV and so on depending on your taste!" Someone (or each SDK team member) has removed these links and therefore I will not recreate this work. The issue however will be resolved in the new site launching 3/18/2013 where the Developer Guide appears in a top level navigation that appears at all times regardless of what guide you are in. I hope that helps. Karen
        Hide
        kzeller kzeller added a comment -

        Hi Tim,

        Sadly I had added a sentence and link to the developer's guide in Drupal to each and every SDK landing page as part of 2.0. It was here for instance:

        http://www.couchbase.com/develop/java/current

        In the section headers with this type content:

        "The Java client library provides fast access to documents in Couchbase Server 2.0. With JSON documents and Couchbase server 2.0 you have new ways to index and query data stored in the cluster through views. These view(s) can be accessed using the newly defined View and Query objects.

        You can provide different perspsectives to the data. For example, on the sample beer data, you can sort by category, ABV and so on depending on your taste!"

        Someone (or each SDK team member) has removed these links and therefore I will not recreate this work. The issue however will be resolved in the new site launching 3/18/2013 where the Developer Guide appears in a top level navigation that appears at all times regardless of what guide you are in. I hope that helps.

        Karen

        Show
        kzeller kzeller added a comment - Hi Tim, Sadly I had added a sentence and link to the developer's guide in Drupal to each and every SDK landing page as part of 2.0. It was here for instance: http://www.couchbase.com/develop/java/current In the section headers with this type content: "The Java client library provides fast access to documents in Couchbase Server 2.0. With JSON documents and Couchbase server 2.0 you have new ways to index and query data stored in the cluster through views. These view(s) can be accessed using the newly defined View and Query objects. You can provide different perspsectives to the data. For example, on the sample beer data, you can sort by category, ABV and so on depending on your taste!" Someone (or each SDK team member) has removed these links and therefore I will not recreate this work. The issue however will be resolved in the new site launching 3/18/2013 where the Developer Guide appears in a top level navigation that appears at all times regardless of what guide you are in. I hope that helps. Karen

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            TimSmith Tim Smith (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 8h
              8h
              Remaining:
              Remaining Estimate - 8h
              8h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Gerrit Reviews

                There are no open Gerrit changes