Uploaded image for project: 'Couchbase Monitoring and Observability Stack'
  1. Couchbase Monitoring and Observability Stack
  2. CMOS-125

Move checker documentation out of cbmultimanager repo

    XMLWordPrintable

Details

    • Task
    • Status: Done
    • Major
    • Resolution: Done
    • None
    • 0.1
    • None

    Description

      The cluster monitor's checkers are (temporarily) documented at https://github.com/couchbaselabs/cbmultimanager/blob/master/doc/checkers.md. This is not where they're going to live long-term - possible places are:

      • In the CMOS AsciiDoc
      • In a KB article (likely managed by Support)
      • Somewhere else?

      We can decide on a permanent place later down the line, but for 0.1 at least we should move them somewhere that's accessible to users, even if we end up moving it again later.

      Attachments

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

        Activity

          Sounds good to me.

          Then just a COPY --from=<cm builder stage> <asciidoc file> /antora/docs... wrapped in a proprietary bit during the Antora stage I think. Cross refs will have to wait until it is properly situated but this would give us docs of the IDs at the very least for 0.1.

          patrick.stephens Patrick Stephens (Inactive) added a comment - - edited Sounds good to me. Then just a COPY --from=<cm builder stage> <asciidoc file> /antora/docs... wrapped in a proprietary bit during the Antora stage I think. Cross refs will have to wait until it is properly situated but this would give us docs of the IDs at the very least for 0.1.

          Build couchbase-cluster-monitor-1.0.0-125 contains cbmultimanager commit 31dfba6 with commit message:
          CMOS-125 Convert checkers.md to AsciiDoc

          build-team Couchbase Build Team added a comment - Build couchbase-cluster-monitor-1.0.0-125 contains cbmultimanager commit 31dfba6 with commit message: CMOS-125 Convert checkers.md to AsciiDoc

          This is merged, gonna wait for the official build to verify.

          marks.polakovs Marks Polakovs (Inactive) added a comment - This is merged, gonna wait for the official build to verify.

          I'll check it later and see if anything needs updating in the docs as well.

          patrick.stephens Patrick Stephens (Inactive) added a comment - I'll check it later and see if anything needs updating in the docs as well.

          Build couchbase-observability-stack-1.0.0-137 contains observability commit 21126db with commit message:
          CMOS-125 Include cluster monitor checkers in Antora build

          build-team Couchbase Build Team added a comment - Build couchbase-observability-stack-1.0.0-137 contains observability commit 21126db with commit message: CMOS-125 Include cluster monitor checkers in Antora build

          People

            patrick.stephens Patrick Stephens (Inactive)
            marks.polakovs Marks Polakovs (Inactive)
            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