Skip to content

Commit

Permalink
Generate documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
  • Loading branch information
chmouel authored and tekton-robot committed Sep 24, 2019
1 parent 1edde1d commit 394c825
Show file tree
Hide file tree
Showing 57 changed files with 140 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/cmd/tkn_clustertask.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Manage clustertasks
-h, --help help for clustertask
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_clustertask_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ tkn ct rm foo
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_clustertask_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Lists clustertasks in a namespace
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Manage pipelines
-h, --help help for pipeline
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipeline_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ tkn p rm foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipeline_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Describes a pipeline in a namespace
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipeline_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Lists pipelines in a namespace
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipeline_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Show pipeline logs
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipeline_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ two parameters (foo and bar)
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipelinerun.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Manage pipelineruns
-h, --help help for pipelinerun
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipelinerun_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Cancel the PipelineRun
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipelinerun_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ tkn pr rm foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipelinerun_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ tkn pr desc foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipelinerun_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ tkn pr list -n foo
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_pipelinerun_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Show the logs of PipelineRun
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Manage pipeline resources
-h, --help help for resource
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_resource_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ tkn res rm foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_resource_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ tkn res desc foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_resource_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ tkn pre list -n foo
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Manage tasks
-h, --help help for task
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_task_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ tkn t rm foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_task_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Lists tasks in a namespace
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_taskrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Manage taskruns
-h, --help help for taskrun
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_taskrun_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ tkn taskrun cancel foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_taskrun_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ tkn tr rm foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_taskrun_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ tkn tr desc foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_taskrun_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ tkn taskrun list foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn_taskrun_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ tkn taskrun logs -f foo -n bar
```
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --nocolour disable colouring (default: false)
```

### SEE ALSO
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-clustertask-delete.1
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Delete a clustertask resource in a cluster
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE

Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-clustertask-list.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Lists clustertasks in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH SEE ALSO
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-clustertask.1
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Manage clustertasks
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH SEE ALSO
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipeline-delete.1
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ Delete a pipeline in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE

Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipeline-describe.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Describes a pipeline in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH SEE ALSO
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipeline-list.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Lists pipelines in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH SEE ALSO
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipeline-logs.1
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ Show pipeline logs
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipeline-start.1
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ Parameters, at least those that have no default value
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipeline.1
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Manage pipelines
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH SEE ALSO
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipelinerun-cancel.1
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Cancel the PipelineRun
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipelinerun-delete.1
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Delete a pipelinerun in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE

Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipelinerun-describe.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Describe a pipelinerun in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE

Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipelinerun-list.1
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Lists pipelineruns in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE

Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipelinerun-logs.1
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ Show the logs of PipelineRun
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-pipelinerun.1
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Manage pipelineruns
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH SEE ALSO
.PP
Expand Down
4 changes: 4 additions & 0 deletions docs/man/man1/tkn-resource-delete.1
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Delete a pipeline resource in a namespace
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-nocolour\fP[=false]
disable colouring (default: false)


.SH EXAMPLE

Expand Down
Loading

0 comments on commit 394c825

Please sign in to comment.