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

Operator 2.2 documentation is harder to read compared to 2.1

    XMLWordPrintable

Details

    • Page
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • not-targeted
    • documentation
    • None
    • 1

    Description

      In 2.2 Documentation, there are several changes to the format of the doc, specifically the sections on Couchbase resource types.

      In 2.1, we have the full yaml structure, then links to each section with the yaml and the explanation. This is easy to read and follow the config, for example, the following couchbasecluster config.

      https://docs.couchbase.com/operator/2.1/reference-couchbasecluster.html

      In 2.2 all of that has been removed and the doc only lists the fields but no yaml examples, and the descriptions are also less informative compared to 2.1 docs.

      https://docs.couchbase.com/operator/current/resource/couchbasecluster.html

      The same goes for the other parts of the resources and other related tutorial pages.

      Attachments

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

        Activity

          tin.tran Tin Tran added a comment -

          hi Roshani Sanghavi
          I'm assigning this to you as I'm not sure whom to assign.

          Thank you Roshani.

          tin.tran Tin Tran added a comment - hi Roshani Sanghavi I'm assigning this to you as I'm not sure whom to assign. Thank you Roshani.
          simon.murray Simon Murray added a comment -

          Ah but the documents are now accurate and up to date as they are generated from source, you can't have it all!

          simon.murray Simon Murray added a comment - Ah but the documents are now accurate and up to date as they are generated from source, you can't have it all!

          People

            roshani.sanghavi Roshani Sanghavi (Inactive)
            tin.tran Tin Tran
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty