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

Docs: All examples of command-line tools should include bucket information

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Major
    • 2.1.0
    • 2.0
    • None
    • Security Level: Public
    • None
    • PCI Team - Sprint 3

    Description

      This page is only an example: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-tasks-replica-backoff.html

      There are places throughout the entire documentation providing examples for our command-line tools. By not providing bucket information, it has been extremely confusing to users on the correct way to use these tools. By not providing any bucket information, the command is being sent to the default bucket. However, if one does not exist, or the user wants to change a different bucket, it's not at all clear from our docs on how to do this.

      Additionally, the main page for these tools should include much more detailed information on how to use them and what/where effect they will have. i.e, a specific bucket on a specific node and not cluster-wide nor even bucket-wide.

      These pages should not use "username" or "password" but rather "bucketname" and "bucketpassword" (even though the tool still says "username", that's a separate issue and I would argue that the docs should be more clear than correct): http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbepctl.html

      Attachments

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

        Activity

          People

            kzeller kzeller
            perry Perry Krug
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty