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

Automated CI for CAO tutorials

    XMLWordPrintable

Details

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

    Description

      During the 2.2 release, several small issues were discovered with the example configs in the tutorial documentation. These issues probably would have been discovered if there was proper automated testing of the example configurations.

      Attachments

        Issue Links

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

          Activity

            Looking at the Go SDK, they use BATS to essentially automatically test the various examples so we could do the same. We would have to extract the relevant bits of code into scripts and resources rather than inside the docs directly - as partials possibly or similar.

            https://github.com/couchbase/docs-sdk-go#documentation-code-sample-testing

            patrick.stephens Patrick Stephens (Inactive) added a comment - Looking at the Go SDK, they use BATS to essentially automatically test the various examples so we could do the same. We would have to extract the relevant bits of code into scripts and resources rather than inside the docs directly - as partials possibly or similar. https://github.com/couchbase/docs-sdk-go#documentation-code-sample-testing

            Shouldn't be too bad to move everything into partials. Or rather, move them into examples.  I need to look into whether subdirectories are supported, but we'll need some sort of organization technique prepared, since the number of these files will explode. Perhaps we can have one file per asciidoc page and then include sections of the file using tags.

            eric.schneider Eric Schneider (Inactive) added a comment - Shouldn't be too bad to move everything into partials. Or rather, move them into examples .  I need to look into whether subdirectories are supported, but we'll need some sort of organization technique prepared, since the number of these files will explode. Perhaps we can have one file per asciidoc page and then include sections of the file using tags .

            Another thing that this effort may accelerate is the need to properly document namespace context. So perhaps we should take a unified approach to namespaces in the tutorials before expanding to the broader documentation.

            eric.schneider Eric Schneider (Inactive) added a comment - Another thing that this effort may accelerate is the need to properly document namespace context. So perhaps we should take a unified approach to namespaces in the tutorials before expanding to the broader documentation.

            I think this is vital for the Fluent Bit side of things as there is a rapid rate of change here and we need to make sure the tutorials stay valid, e.g. the documentation and tag naming for S3 plugin has changed between 1.6 and 1.7.

            patrick.stephens Patrick Stephens (Inactive) added a comment - I think this is vital for the Fluent Bit side of things as there is a rapid rate of change here and we need to make sure the tutorials stay valid, e.g. the documentation and tag naming for S3 plugin has changed between 1.6 and 1.7.

            People

              patrick.stephens Patrick Stephens (Inactive)
              eric.schneider Eric Schneider (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty