Skip to content

Commit

Permalink
Attempt to fix formatting of examples
Browse files Browse the repository at this point in the history
  • Loading branch information
imjasonh committed Dec 18, 2019
1 parent b13f6cf commit df91de7
Show file tree
Hide file tree
Showing 74 changed files with 665 additions and 244 deletions.
8 changes: 5 additions & 3 deletions docs/cmd/tkn_clustertask_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a clustertask resource in a cluster

### Examples

Delete a ClusterTask of name 'foo':

# Delete a ClusterTask of name 'foo'
tkn clustertask delete foo
tkn clustertask delete foo

tkn ct rm foo
or

tkn ct rm foo


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_condition_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a condition in a namespace

### Examples

Delete a Condition of name 'foo' in namespace 'bar':

# Delete a Condition of name 'foo' in namespace 'bar'
tkn condition delete foo -n bar
tkn condition delete foo -n bar

tkn cond rm foo -n bar
or

tkn cond rm foo -n bar


### Options
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/tkn_pipeline_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Create a pipeline in a namespace

### Examples

Create a Pipeline defined by foo.yaml in namespace 'bar':

# Create a Pipeline defined by foo.yaml in namespace 'bar'
tkn pipeline create -f foo.yaml -n bar
tkn pipeline create -f foo.yaml -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_pipeline_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a pipeline in a namespace

### Examples

Delete a Pipeline of name 'foo' in namespace 'bar'

# Delete a Pipeline of name 'foo' in namespace 'bar'
tkn pipeline delete foo -n bar
tkn pipeline delete foo -n bar

tkn p rm foo -n bar
or

tkn p rm foo -n bar


### Options
Expand Down
13 changes: 8 additions & 5 deletions docs/cmd/tkn_pipeline_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,22 @@ Show pipeline logs
### Examples


# interactive mode: shows logs of the selected pipeline run
Interactive mode: shows logs of the selected pipelinerun:

tkn pipeline logs -n namespace

# interactive mode: shows logs of the selected pipelinerun of the given pipeline
Interactive mode: shows logs of the selected pipelinerun of the given pipeline:

tkn pipeline logs pipeline -n namespace

# show logs of given pipeline for last run
Show logs of given pipeline for last run:

tkn pipeline logs pipeline -n namespace --last

# show logs for given pipeline and pipelinerun
Show logs for given pipeline and pipelinerun:

tkn pipeline logs pipeline run -n namespace



### Options

Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/tkn_pipelinerun_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Cancel the PipelineRun

### Examples

Cancel the PipelineRun named 'foo' from namespace 'bar':

# cancel the PipelineRun named "foo" from the namespace "bar"
tkn pipelinerun cancel foo -n bar


### Options

Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_pipelinerun_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a pipelinerun in a namespace

### Examples

Delete a PipelineRun of name 'foo' in namespace 'bar':

# Delete a PipelineRun of name 'foo' in namespace 'bar'
tkn pipelinerun delete foo -n bar
tkn pipelinerun delete foo -n bar

tkn pr rm foo -n bar
or

tkn pr rm foo -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_pipelinerun_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Describe a pipelinerun in a namespace

### Examples

Describe a PipelineRun of name 'foo' in namespace 'bar':

# Describe a PipelineRun of name 'foo' in namespace 'bar'
tkn pipelinerun describe foo -n bar
tkn pipelinerun describe foo -n bar

tkn pr desc foo -n bar
or

tkn pr desc foo -n bar


### Options
Expand Down
9 changes: 5 additions & 4 deletions docs/cmd/tkn_pipelinerun_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ Lists pipelineruns in a namespace

### Examples

List all PipelineRuns of Pipeline 'foo':

# List all PipelineRuns of Pipeline name 'foo'
tkn pipelinerun list foo -n bar
tkn pipelinerun list foo -n bar

# List all pipelineruns in a namespaces 'foo'
tkn pr list -n foo
List all PipelineRuns in a namespace 'foo':

tkn pr list -n foo


### Options
Expand Down
9 changes: 5 additions & 4 deletions docs/cmd/tkn_pipelinerun_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@ Show the logs of PipelineRun

### Examples

Show the logs of PipelineRun named 'foo' from namespace 'bar':

# show the logs of PipelineRun named "foo" from the namesspace "bar"
tkn pipelinerun logs foo -n bar

# show the logs of PipelineRun named "microservice-1" for task "build" only, from the namespace "bar"
Show the logs of PipelineRun named 'microservice-1' for task 'build' only from namespace 'bar':

tkn pr logs microservice-1 -t build -n bar

# show the logs of PipelineRun named "microservice-1" for all tasks and steps (including init steps),
from the namespace "foo"
Show the logs of PipelineRun named 'microservice-1' for all tasks and steps (including init steps) from namespace 'foo':

tkn pr logs microservice-1 -a -n foo


Expand Down
12 changes: 7 additions & 5 deletions docs/cmd/tkn_resource_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ Create a pipeline resource in a namespace

### Examples

Creates new PipelineResource as per the given input:

tkn resource create -n namespace

Create a PipelineResource defined by foo.yaml in namespace 'bar':

tkn resource create -f foo.yaml -n bar

# Creates new PipelineResource as per the given input
tkn resource create -n namespace

# Create a PipelineResource defined by foo.yaml in namespace 'bar'
tkn resource create -f foo.yaml -n bar

### Options

Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_resource_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a pipeline resource in a namespace

### Examples

Delete a PipelineResource of name 'foo' in namespace 'bar':

# Delete a PipelineResource of name 'foo' in namespace 'bar'
tkn resource delete foo -n bar
tkn resource delete foo -n bar

tkn res rm foo -n bar
or

tkn res rm foo -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_resource_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Describes a pipeline resource in a namespace

### Examples

Describe a PipelineResource of name 'foo' in namespace 'bar':

# Describe a PipelineResource of name 'foo' in namespace 'bar'
tkn resource describe foo -n bar
tkn resource describe foo -n bar

tkn res desc foo -n bar
or

tkn res desc foo -n bar


### Options
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/tkn_resource_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Lists pipeline resources in a namespace

### Examples

List all PipelineResources in a namespace 'foo':

# List all PipelineResources in a namespaces 'foo'
tkn pre list -n foo
tkn pre list -n foo


### Options
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/tkn_task_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Create a task in a namespace

### Examples

Create a Task defined by foo.yaml in namespace 'bar':

# Create a Task defined by foo.yaml in namespace 'bar'
tkn task create -f foo.yaml -n bar
tkn task create -f foo.yaml -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_task_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a task resource in a namespace

### Examples

Delete a Task of name 'foo' in namespace 'bar':

# Delete a Task of name 'foo' in namespace 'bar'
tkn task delete foo -n bar
tkn task delete foo -n bar

tkn t rm foo -n bar
or

tkn t rm foo -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_task_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Describes a task in a namespace

### Examples

Describe a Task of name 'foo' in namespace 'bar':

# Describe a task of name 'foo' in namespace 'bar'
tkn task describe foo -n bar
tkn task describe foo -n bar

tkn t desc foo -n bar
or

tkn t desc foo -n bar


### Options
Expand Down
12 changes: 7 additions & 5 deletions docs/cmd/tkn_task_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,22 @@ Show task logs

### Examples

Interactive mode: shows logs of the selected TaskRun:

# interactive mode: shows logs of the selected taskrun
tkn task logs -n namespace

# interactive mode: shows logs of the selected taskrun of the given task
Interactive mode: shows logs of the selected TaskRun of the given Task:

tkn task logs task -n namespace

# show logs of given task for last taskrun
Show logs of given Task for last TaskRun:

tkn task logs task -n namespace --last

# show logs for given task and taskrun
Show logs for given task and taskrun:

tkn task logs task taskrun -n namespace



### Options

Expand Down
6 changes: 3 additions & 3 deletions docs/cmd/tkn_task_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Start tasks

### Examples

Start Task foo by creating a TaskRun named "foo-run-xyz123" from namespace 'bar':

# start task foo by creating a taskrun named "foo-run-xyz123" from the namespace "bar"
tkn task start foo -s ServiceAccountName -n bar
tkn task start foo -s ServiceAccountName -n bar

The task can either be specified by reference in a cluster using the positional argument
The rask can either be specified by reference in a cluster using the positional argument
or in a file using the --filename argument.

For params value, if you want to provide multiple values, provide them comma separated
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_taskrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Manage taskruns
* [tkn taskrun cancel](tkn_taskrun_cancel.md) - Cancel a taskrun in a namespace
* [tkn taskrun delete](tkn_taskrun_delete.md) - Delete a taskrun in a namespace
* [tkn taskrun describe](tkn_taskrun_describe.md) - Describe a taskrun in a namespace
* [tkn taskrun list](tkn_taskrun_list.md) - Lists taskruns in a namespace
* [tkn taskrun list](tkn_taskrun_list.md) - Lists TaskRuns in a namespace
* [tkn taskrun logs](tkn_taskrun_logs.md) - Show taskruns logs

4 changes: 2 additions & 2 deletions docs/cmd/tkn_taskrun_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Cancel a taskrun in a namespace

### Examples

Cancel the TaskRun named 'foo' from the namespace 'bar':

# Cancel the TaskRun named "foo" from the namespace "bar"
tkn taskrun cancel foo -n bar
tkn taskrun cancel foo -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_taskrun_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Delete a taskrun in a namespace

### Examples

Delete a TaskRun of name 'foo' in namespace 'bar':

# Delete a TaskRun of name 'foo' in namespace 'bar'
tkn taskrun delete foo -n bar
tkn taskrun delete foo -n bar

tkn tr rm foo -n bar
or

tkn tr rm foo -n bar


### Options
Expand Down
8 changes: 5 additions & 3 deletions docs/cmd/tkn_taskrun_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ Describe a taskrun in a namespace

### Examples

Describe a TaskRun of name 'foo' in namespace 'bar':

# Describe a TaskRun of name 'foo' in namespace 'bar'
tkn taskrun describe foo -n bar
tkn taskrun describe foo -n bar

tkn tr desc foo -n bar
or

tkn tr desc foo -n bar


### Options
Expand Down
Loading

0 comments on commit df91de7

Please sign in to comment.