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

Helm Doc Auto-generation PART 2: Refinement

    XMLWordPrintable

Details

    • Page
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • not-targeted
    • documentation, helm
    • None
    • 1

    Description

      This ticket is a follow-up to K8S-1991. In that ticket, a process was developed for automatically generating the documentation for the Helm chart spec – a table is generated that lists all of the fields that are currently in the Helm chart values file, as well as the descriptions of those fields from the various CRDs.

      The auto-generated table is has space constraints and general usability issues. This ticket is meant to refine the auto-generated table and improve the overall usability of the web documentation for the Helm chart spec.

      Attachments

        Issue Links

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

          Activity

            eric.schneider Eric Schneider (Inactive) created issue -
            eric.schneider Eric Schneider (Inactive) made changes -
            Field Original Value New Value
            Link This issue relates to K8S-1991 [ K8S-1991 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1991 [ K8S-1991 ]
            eric.schneider Eric Schneider (Inactive) made changes -
            Link This issue relates to K8S-1991 [ K8S-1991 ]
            simon.murray Simon Murray made changes -
            Rank Ranked higher
            simon.murray Simon Murray made changes -
            Rank Ranked higher
            simon.murray Simon Murray made changes -
            Rank Ranked higher
            simon.murray Simon Murray made changes -
            Rank Ranked higher
            ingenthr Matt Ingenthron made changes -
            Assignee Eric Schneider [ eric.schneider ] Anil Kumar [ anil ]
            simon.murray Simon Murray made changes -
            Rank Ranked lower

            Its done.

            justin.ashworth Justin Ashworth added a comment - Its done.
            justin.ashworth Justin Ashworth made changes -
            Resolution Fixed [ 1 ]
            Status Open [ 1 ] Closed [ 6 ]

            People

              anil Anil Kumar (Inactive)
              eric.schneider Eric Schneider (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