Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Common Way of Referring to Tekton Resources for User Facing Messages: Task #1032

Merged
merged 1 commit into from
Jun 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cmd/tkn.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ CLI for tekton pipelines
* [tkn pipeline](tkn_pipeline.md) - Manage pipelines
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn resource](tkn_resource.md) - Manage pipeline resources
* [tkn task](tkn_task.md) - Manage tasks
* [tkn task](tkn_task.md) - Manage Tasks
* [tkn taskrun](tkn_taskrun.md) - Manage TaskRuns
* [tkn triggerbinding](tkn_triggerbinding.md) - Manage triggerbindings
* [tkn triggertemplate](tkn_triggertemplate.md) - Manage triggertemplates
Expand Down
14 changes: 7 additions & 7 deletions docs/cmd/tkn_task.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## tkn task

Manage tasks
Manage Tasks

***Aliases**: t,tasks*

### Synopsis

Manage tasks
Manage Tasks

### Options

Expand All @@ -21,9 +21,9 @@ Manage tasks
### SEE ALSO

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn task delete](tkn_task_delete.md) - Delete task resources in a namespace
* [tkn task describe](tkn_task_describe.md) - Describes a task in a namespace
* [tkn task list](tkn_task_list.md) - Lists tasks in a namespace
* [tkn task logs](tkn_task_logs.md) - Show task logs
* [tkn task start](tkn_task_start.md) - Start tasks
* [tkn task delete](tkn_task_delete.md) - Delete Tasks in a namespace
* [tkn task describe](tkn_task_describe.md) - Describe a Task in a namespace
* [tkn task list](tkn_task_list.md) - Lists Tasks in a namespace
* [tkn task logs](tkn_task_logs.md) - Show Task logs
* [tkn task start](tkn_task_start.md) - Start Tasks

6 changes: 3 additions & 3 deletions docs/cmd/tkn_task_delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn task delete

Delete task resources in a namespace
Delete Tasks in a namespace

***Aliases**: rm*

Expand All @@ -12,7 +12,7 @@ tkn task delete

### Synopsis

Delete task resources in a namespace
Delete Tasks in a namespace

### Examples

Expand Down Expand Up @@ -48,5 +48,5 @@ or

### SEE ALSO

* [tkn task](tkn_task.md) - Manage tasks
* [tkn task](tkn_task.md) - Manage Tasks

6 changes: 3 additions & 3 deletions docs/cmd/tkn_task_describe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn task describe

Describes a task in a namespace
Describe a Task in a namespace

***Aliases**: desc*

Expand All @@ -12,7 +12,7 @@ tkn task describe

### Synopsis

Describes a task in a namespace
Describe a Task in a namespace

### Examples

Expand Down Expand Up @@ -45,5 +45,5 @@ or

### SEE ALSO

* [tkn task](tkn_task.md) - Manage tasks
* [tkn task](tkn_task.md) - Manage Tasks

8 changes: 4 additions & 4 deletions docs/cmd/tkn_task_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn task list

Lists tasks in a namespace
Lists Tasks in a namespace

***Aliases**: ls*

Expand All @@ -12,12 +12,12 @@ tkn task list

### Synopsis

Lists tasks in a namespace
Lists Tasks in a namespace

### Options

```
-A, --all-namespaces list tasks from all namespaces
-A, --all-namespaces list Tasks from all namespaces
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for list
--no-headers do not print column headers with output (default print column headers with output)
Expand All @@ -36,5 +36,5 @@ Lists tasks in a namespace

### SEE ALSO

* [tkn task](tkn_task.md) - Manage tasks
* [tkn task](tkn_task.md) - Manage Tasks

12 changes: 6 additions & 6 deletions docs/cmd/tkn_task_logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn task logs

Show task logs
Show Task logs

### Usage

Expand All @@ -10,7 +10,7 @@ tkn task logs

### Synopsis

Show task logs
Show Task logs

### Examples

Expand All @@ -26,7 +26,7 @@ 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 associated TaskRun:

tkn task logs task taskrun -n namespace

Expand All @@ -37,8 +37,8 @@ Show logs for given task and taskrun:
-a, --all show all logs including init steps injected by tekton
-f, --follow stream live logs
-h, --help help for logs
-L, --last show logs for last taskrun
--limit int lists number of taskruns (default 5)
-L, --last show logs for last TaskRun
--limit int lists number of TaskRuns (default 5)
```

### Options inherited from parent commands
Expand All @@ -52,5 +52,5 @@ Show logs for given task and taskrun:

### SEE ALSO

* [tkn task](tkn_task.md) - Manage tasks
* [tkn task](tkn_task.md) - Manage Tasks

28 changes: 14 additions & 14 deletions docs/cmd/tkn_task_start.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
## tkn task start

Start tasks
Start Tasks

### Usage

```
tkn task start task [RESOURCES...] [PARAMS...] [SERVICEACCOUNT]
tkn task start [RESOURCES...] [PARAMS...] [SERVICEACCOUNT]
```

### Synopsis

Start tasks
Start Tasks

### Examples

Start Task foo by creating a TaskRun named "foo-run-xyz123" from namespace '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 Task 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
For params values, if you want to provide multiple values, provide them comma separated
like cat,foo,bar


### Options

```
--dry-run preview taskrun without running it
-f, --filename string local or remote file name containing a task definition to start a taskrun
--dry-run preview TaskRun without running it
-f, --filename string local or remote file name containing a Task definition to start a TaskRun
-h, --help help for start
-i, --inputresource strings pass the input resource name and ref as name=ref
-l, --labels strings pass labels as label=value.
-L, --last re-run the task using last taskrun values
--output string format of taskrun dry-run (yaml or json)
-L, --last re-run the Task using last TaskRun values
--output string format of TaskRun dry-run (yaml or json)
-o, --outputresource strings pass the output resource name and ref as name=ref
-p, --param stringArray pass the param as key=value for string type, or key=value1,value2,... for array type
--prefix-name string specify a prefix for the taskrun name (must be lowercase alphanumeric characters)
--prefix-name string specify a prefix for the TaskRun name (must be lowercase alphanumeric characters)
-s, --serviceaccount string pass the serviceaccount name
--showlog show logs right after starting the task
--timeout string timeout for taskrun
--use-taskrun string specify a taskrun name to use its values to re-run the taskrun
--showlog show logs right after starting the Task
--timeout string timeout for TaskRun
--use-taskrun string specify a TaskRun name to use its values to re-run the TaskRun
-w, --workspace stringArray pass the workspace.
```

Expand All @@ -56,5 +56,5 @@ like cat,foo,bar

### SEE ALSO

* [tkn task](tkn_task.md) - Manage tasks
* [tkn task](tkn_task.md) - Manage Tasks

4 changes: 2 additions & 2 deletions docs/man/man1/tkn-task-delete.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-task\-delete \- Delete task resources in a namespace
tkn\-task\-delete \- Delete Tasks in a namespace


.SH SYNOPSIS
Expand All @@ -15,7 +15,7 @@ tkn\-task\-delete \- Delete task resources in a namespace

.SH DESCRIPTION
.PP
Delete task resources in a namespace
Delete Tasks in a namespace


.SH OPTIONS
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/tkn-task-describe.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-task\-describe \- Describes a task in a namespace
tkn\-task\-describe \- Describe a Task in a namespace


.SH SYNOPSIS
Expand All @@ -15,7 +15,7 @@ tkn\-task\-describe \- Describes a task in a namespace

.SH DESCRIPTION
.PP
Describes a task in a namespace
Describe a Task in a namespace


.SH OPTIONS
Expand Down
6 changes: 3 additions & 3 deletions docs/man/man1/tkn-task-list.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-task\-list \- Lists tasks in a namespace
tkn\-task\-list \- Lists Tasks in a namespace


.SH SYNOPSIS
Expand All @@ -15,13 +15,13 @@ tkn\-task\-list \- Lists tasks in a namespace

.SH DESCRIPTION
.PP
Lists tasks in a namespace
Lists Tasks in a namespace


.SH OPTIONS
.PP
\fB\-A\fP, \fB\-\-all\-namespaces\fP[=false]
list tasks from all namespaces
list Tasks from all namespaces

.PP
\fB\-\-allow\-missing\-template\-keys\fP[=true]
Expand Down
10 changes: 5 additions & 5 deletions docs/man/man1/tkn-task-logs.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-task\-logs \- Show task logs
tkn\-task\-logs \- Show Task logs


.SH SYNOPSIS
Expand All @@ -15,7 +15,7 @@ tkn\-task\-logs \- Show task logs

.SH DESCRIPTION
.PP
Show task logs
Show Task logs


.SH OPTIONS
Expand All @@ -33,11 +33,11 @@ Show task logs

.PP
\fB\-L\fP, \fB\-\-last\fP[=false]
show logs for last taskrun
show logs for last TaskRun

.PP
\fB\-\-limit\fP=5
lists number of taskruns
lists number of TaskRuns


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down Expand Up @@ -96,7 +96,7 @@ tkn task logs task \-n namespace \-\-last
.RE

.PP
Show logs for given task and taskrun:
Show logs for given Task and associated TaskRun:

.PP
.RS
Expand Down
Loading