Uploaded image for project: 'Knative Serving'
  1. Knative Serving
  2. SRVKS-20

[DOC] Document Knative Serving Operator using new documentation guidelines from OpenShift team

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • Documentation
    • Serverless Sprint 164, Serverless Sprint 166

      A ClusterServiceVersion (CSV) includes a “Description” field in the Operator metadata. This self-documentation is shown to users in the OCP 4.0 web console via Operators ? Cluster Service Versions ? Overview ? Description. From https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#operator-metadata

      Description: A markdown blob that describes the Operator. Important information to include: features, limitations and common use-cases for the Operator. If your Operator manages different types of installs, eg. standalone vs clustered, it is useful to give an overview of how each differs from each other, or which ones are supported for production use.

      Operator authors provide content in their metadata; documentation team members are encouraged to collaborate on this and provide feedback.

              jcrossle@redhat.com Jim Crossley
              abrennan@redhat.com Ashleigh Brennan
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: