Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-6143

Update Pipeline run commands section to follow correct style

XMLWordPrintable

    • 3
    • ---
    • ---

      We need to update this section: https://docs.openshift.com/pipelines/1.15/tkn_cli/op-tkn-reference.html#op-tkn-pipeline-run_op-tkn-referencecalled Pipeline run commands so that it follows our style guide.

      Raise the PR against pipelines-docs-main branch. Cherry-pick branches are pipelines-docs-1.14, pipelines-docs-1.15, and pipelines-docs-1.16.

      Please make the following changes in the op-tkn-pipeline-run.adoc file:

       1. LINE 20-24 from:

      .Example: Cancel the `mypipelinerun` pipeline run from a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun cancel mypipelinerun -n myspace
      ----

      to:

      .Example: Cancel a pipeline run from a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
      ----

       

      2. LINE 29-33 ** from:

      .Example: Delete pipeline runs from a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
      ----

      to:

      .Example: Delete pipeline runs from a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
      ----

       

      3. LINE 38 from:

      $ tkn pipelinerun delete -n myspace --keep 5 <1>

      to:

      $ tkn pipelinerun delete -n <namespace_name> --keep 5 <1>

       

      4. LINE 56-60 from:

      .Example: Describe the `mypipelinerun` pipeline run in a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun describe mypipelinerun -n myspace
      ----

      to:

      .Example: Describe a pipeline run in a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>
      ----

       

      5. LINE 68 from:

      $ tkn pipelinerun list -n myspace

      to:

      $ tkn pipelinerun list -n <namespace_name>

       

      6. LINE 74-78 from:

      .Example: Display the logs of the `mypipelinerun` pipeline run with all tasks and steps in a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun logs mypipelinerun -a -n myspace
      ----

      to:

      .Example: Display the logs of a pipeline run with all tasks and steps in a namespace
      [source,terminal]
      ----
      $ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
      ----

       

       

              rhn-support-srr Srivaralakshmi Ramani
              eromanov@redhat.com Eliska Romanova
              Abhishek Sharma
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: