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

Update Pipelines management commands section to follow correct style

XMLWordPrintable

      We need to update this section: https://docs.openshift.com/pipelines/1.15/tkn_cli/op-tkn-reference.html#op-tkn-pipeline-management_op-tkn-reference
      called Pipelines management 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-management.adoc file:
       1. LINE 20-24: from:

      .Example: Delete the `mypipeline` pipeline from a namespace
      [source,terminal]
      ----
      $ tkn pipeline delete mypipeline -n myspace
      ---- 

      to:

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

       

      2. LINE 29-33 from:

      .Example: Describe the `mypipeline` pipeline
      [source,terminal]
      ----
      $ tkn pipeline describe mypipeline
      ----

      to:

      .Example: Describe a pipeline
      [source,terminal]
      ---- 
      $ tkn pipeline describe <pipeline_name>
      ----

       

      3. LINE 47-51 from:

      .Example: Stream the live logs for the `mypipeline` pipeline
      [source,terminal]
      ----
      $ tkn pipeline logs -f mypipeline
      ----

      to:

      .Example: Stream the live logs for a pipeline
      [source,terminal]
      ----
      $ tkn pipeline logs -f <pipeline_name>
      ----

       

      4. LINE 56-60 from:

      .Example: Start the `mypipeline` pipeline
      [source,terminal]
      ----
      $ tkn pipeline start mypipeline
      ----

      to:

      .Example: Start a pipeline
      [source,terminal]
      ----
      $ tkn pipeline start <pipeline_name>
      ----

       

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

              Created:
              Updated:
              Resolved: