Uploaded image for project: 'OpenShift Pipelines'
  1. OpenShift Pipelines
  2. SRVKP-830

Add Tekton API docs (oc explain)

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • Minor
    • None
    • None
    • Tekton Pipelines
    • Add Tekton API docs (oc explain)
    • To Do
    • 0
    • 0% 0%

    Description

      Problem:

      Tekton API docs are not available and user has to look into Go code to get accurate description of the fields available on CRDs

      Goal:

      As a Tekton user, I want to have access to the Tekton API documentation through "oc explain" and also API explore in the Admin Console, so that I can easily find out available fields when creating Tekton resources and their documentations.

      Why is it important?

      To simplify creating Tekton resources

      Acceptance criteria:

      1. oc explain displays Tekton resources description and fields
      2. Tekton resources description and fields are available in the Explore view in Admin Console

      Attachments

        1. dc-api.png
          dc-api.png
          357 kB
        2. pipeline-api.png
          pipeline-api.png
          205 kB

        Activity

          People

            Unassigned Unassigned
            ssadeghi@redhat.com Siamak Sadeghianfar
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: