Uploaded image for project: 'Couchbase Kubernetes'
  1. Couchbase Kubernetes
  2. K8S-500

Improve Quick Start Guides

    XMLWordPrintable

Details

    • Task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 1.0.0
    • documentation
    • None

    Description

      More from Perry.  Essentially people copy and paste everything without reading the documentation and don't actually know what they are doing as regards the wider k8s environment.

      Top points:

      • Devs don't ever make it as far as the bits that document the RBAC processes fully.  They should be show the steps in a simple bulleted list at the top of each quick start guide with links into the relevant documentation, and mark it as very important
      • Devs don't pay attention to what they are running and just use what we give them.  We need to be far better at indicating which fields are customizable e.g. names, namespaces etc.  (Can we highlight things in verbatim text??)
      • The names we use are pretty ambiguous in that they are all the same e.g. "couchbase-operator", if we were a bit clearer it may be more obvious what things relate to other things.  If we were demoing running commands we'd say export FOO=bar which would be pretty obvious when used which things are customizable, and how they link together.

      Attachments

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

        Activity

          There are no comments yet on this issue.

          People

            simon.murray Simon Murray
            simon.murray Simon Murray
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty