Uploaded image for project: 'OpenShift API Server'
  1. OpenShift API Server
  2. API-1410

OpenShift APIServer component doesn't have a README

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • openshift-apiserver
    • None
    • False
    • None
    • False

      The OpenShift APIServer component doesn't have a README.

      Red Hat's support teams are required to have an overview knowledge of a large number of OpenShift internal components. This allows them to group support cases to specific components and review the code for bug-finding.

      This becomes difficult when components don't provide a README or overview documentation. This will require a senior resource immediately that can read the code instead of allowing frontline staff to review the documentation and perform initial triaging.

      This will assist the support teams by reducing the overhead for senior resources and allow junior engineers to broaden their capabilities. 

      A good example of a component that provides this is the OpenShift MachineAPI: https://github.com/openshift/machine-api-operator

      Please provide a README explaining the main purpose/function of the OpenShift APIServer:
      https://github.com/openshift/openshift-apiserver
      https://github.com/openshift/openshift-apiserver/issues/169

       

              sttts@redhat.com Stefan Schimanski (Inactive)
              rhn-support-mwasher Michael Washer (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: