From 3a791d8f215d3d45688c6cc2973afa70b26c19ec Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Wed, 4 Mar 2020 10:36:30 +0530 Subject: [PATCH 1/6] Updates to CLI Reference - RHDEVDOCS-1521 --- modules/ROOT/nav.adoc | 12 ++- .../ROOT/pages/assembly_cli-reference.adoc | 4 +- .../op-tkn-cli-clustertask-management.adoc | 46 ++++++++++ .../op-tkn-cli-condition-management.adoc | 30 +++++++ .../pages/op-tkn-cli-pipeline-management.adoc | 63 ++++++++++++++ ...-tkn-cli-pipeline-resource-management.adoc | 45 ++++++++++ .../ROOT/pages/op-tkn-cli-pipeline-run.adoc | 55 ++++++++++++ modules/ROOT/pages/op-tkn-cli-reference.adoc | 25 ++++++ .../pages/op-tkn-cli-task-management.adoc | 62 ++++++++++++++ modules/ROOT/pages/op-tkn-cli-task-run.adoc | 56 ++++++++++++ .../pages/op-tkn-cli-trigger-management.adoc | 77 +++++++++++++++++ .../pages/op-tkn-cli-utility-commands.adoc | 30 +++++++ modules/ROOT/pages/ref_cli-reference.adoc | 85 ------------------- 13 files changed, 502 insertions(+), 88 deletions(-) create mode 100644 modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-condition-management.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-reference.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-task-management.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-task-run.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-trigger-management.adoc create mode 100644 modules/ROOT/pages/op-tkn-cli-utility-commands.adoc delete mode 100644 modules/ROOT/pages/ref_cli-reference.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 46ab2b92..065dee31 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -21,5 +21,15 @@ ** xref:proc_interacting-with-pipelines-using-the-developer-perspective.adoc[4.2 Interacting with pipelines using the Developer perspective] * xref:assembly_cli-reference.adoc[5. CLI Reference] ** xref:proc_installing-cli.adoc[5.1 Installing CLI] -** xref:ref_cli-reference.adoc[5.2 Basic Commands] +** xref:op-tkn-cli-reference.adoc[5.2 Basic Commands] +*** xref:op-tkn-cli-utility-commands.adoc[5.2.1 Utility Commands] +*** xref:op-tkn-cli-pipeline-management.adoc[5.2.2 Pipeline Management Commands] +*** xref:op-tkn-cli-pipeline-run.adoc[5.2.3 Pipeline Run Commands] +*** xref:op-tkn-cli-task-management.adoc[5.2.4 Task Management Commands] +*** xref:op-tkn-cli-task-run.adoc[5.2.5 Task Run Commands] +*** xref:op-tkn-cli-condition-management.adoc[5.2.6 Condition Management Commands] +*** xref:op-tkn-cli-pipeline-resource-management.adoc[5.2.7 Pipeline Resource Management Commands] +*** xref:op-tkn-cli-clustertask-management.adoc[5.2.8 Clustertask Management Commands] +*** xref:op-tkn-cli-trigger-management.adoc[[5.2.9 Trigger Management Commands] + * xref:release_notes.adoc[Release Notes] diff --git a/modules/ROOT/pages/assembly_cli-reference.adoc b/modules/ROOT/pages/assembly_cli-reference.adoc index 3c82a247..650f7ac3 100644 --- a/modules/ROOT/pages/assembly_cli-reference.adoc +++ b/modules/ROOT/pages/assembly_cli-reference.adoc @@ -5,7 +5,7 @@ :context: cli-reference -With the Tekton Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands. +With the Tekton Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands. // CLI Installation Guide @@ -13,7 +13,7 @@ include::proc_installing-cli.adoc[leveloffset=+1] // CLI Reference -include::ref_cli-reference.adoc[leveloffset=+1] +include::op-tkn-cli-reference.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc b/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc new file mode 100644 index 00000000..df34cd75 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-reference.adoc + +[id="cli-clustertask-management-commands_{context}"] += Clustertask Management Commands + +== tkn clustertask +Manage clustertasks. + +.Example: Display help +---- +$ tkn clustertask --help +---- + +== tkn clustertask delete +Delete a clustertask resource in a cluster. + +.Example: Delete `mytask1` and `mytask2` clustertasks +---- +$ tkn clustertask delete mytask1 mytask2 +---- + + +== tkn clustertask describe +Describes a clustertask. + +.Example: Describe the `mytask` clustertask +---- +$ tkn clustertask describe mytask1 +---- + +== tkn clustertask list +List clustertasks in a namespace. + +.Example: List clustertasks in a namespace +---- +$ tkn clustertask list -n myspace +---- +== tkn clustertask start +Start clustertasks. + +.Example: Start the `mytask` clustertask in a namespace +---- +$ tkn clustertask start mytask -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-cli-condition-management.adoc b/modules/ROOT/pages/op-tkn-cli-condition-management.adoc new file mode 100644 index 00000000..6526a9f6 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-condition-management.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-references.adoc + +[id="cli-condition-management-commands_{context}"] += Condition Management Commands + +== tkn condition +Manage conditions. + +.Example: Display help +---- +$ tkn condition --help +---- + +== tkn condition delete +Delete a condition in a namespace. + +.Example: Delete the `mycondition1` condition from a namespace +---- +$ tkn condition delete mycondition1 -n myspace +---- + +== tkn condition list +List conditions in a namespace. + +.Example: List conditions in a namespace +---- +$ tkn condition list -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc new file mode 100644 index 00000000..60d6c3ce --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc @@ -0,0 +1,63 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-references.adoc + +[id="cli-pipeline-management-commands_{context}"] += Pipelines Management Commands + +== tkn pipeline +Manage pipelines. + +.Example: Display help +---- +$ pipeline --help +---- + +== tkn pipeline create +Create a pipeline in a namespace. + +.Example: Create a pipeline defined by the `mypipeline.yaml` file in a namespace +----- +$ tkn pipeline create -f mypipeline.yaml -n myspace +----- + +== tkn pipeline delete + +Delete a pipeline in a namespace. + +.Example: Delete the `mypipeline` pipeline from a namespace +---- +$ tkn pipeline delete mypipeline -n myspace +---- + +== tkn pipeline describe +Describe a pipeline in a namespace. + +.Example: Describe `mypipeline` pipeline +---- +$ tkn pipeline describe mypipeline +---- + +== tkn pipeline list +List pipelines in a namespace. + +.Example: Display a list of pipelines +----- +$ tkn pipeline list +----- + +== tkn pipeline logs +Display pipeline logs for a specific pipeline . + +.Example: Stream live logs for the `mypipeline` pipeline +---- +$ tkn pipeline logs -f mypipeline +---- + +== tkn pipeline start +Start a pipeline. + +.Example: Start a pipeline +---- +$ tkn pipeline start mypipeline +---- diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc new file mode 100644 index 00000000..79e7bb0b --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc @@ -0,0 +1,45 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-reference.adoc + +[id="cli-pipeline-resources-management-commands_{context}"] += Pipeline Resource Management Commands + +== tkn resource +Manage pipeline resources. + +.Example: Display help +---- +$ tkn resource -h +---- + +== tkn resource create +Create a pipeline resource in a namespace. + +.Example: Create pipeline resource defined by the `myresource.yaml` file in a namespace +---- +$ tkn resource create -f myresource.yaml -n myspace +---- + +== tkn resource delete +Delete a pipeline resource in a namespace. + +.Example: Delete the `myresource` pipeline resource from a namespace +---- +$ tkn resource delete myresource -n myspace +---- + +== tkn resource describe +Describes a pipeline resource in a namespace. + +.Example: Describe the `myresource` pipeline resource +---- +$ tkn resource describe myresource -n `myspace` +---- +== tkn resource list +List pipeline resources in a namespace. + +.Example: List all pipeline resources in a namespace +---- +$ tkn resource list -n `myspace` +---- diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc new file mode 100644 index 00000000..6823e914 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc @@ -0,0 +1,55 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-references.adoc + +[id="cli-pipeline-run-commands_{context}"] += Pipelines Run Commands + + +== tkn pipelinerun +Manage pipelineruns. + +.Example: Display help +---- +$ tkn pipelinerun -h +---- + +== tkn pipelinerun cancel +Cancel a pipelinerun in a namespace. + +.Example: Cancel the `mypipelinerun` pipelinerun from a namespace +---- +$ tkn pipeline cancel mypipelinerun -n myspace +---- + +== tkn pipelinerun delete +Delete pipelinerun in a namespace. + +.Example: Delete pipelineruns from a namespace +---- +$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace +---- + +== tkn pipelinerun describe +Describe a pipelinerun in a namespace. + +.Example: Describe the `mypipelinerun` pipelinerun in a namespace +---- +tkn pipelinerun describe mypipelinerun -n myspace +---- + +== tkn pipelinerun list +Display a list of pipelineruns in a namespace. + +.Example: Display a list of pipelineruns in a namespace +---- +$ tkn pipelinerun list -n myspace +---- + +== tkn pipelinerun logs +Show the logs of pipelinerun. + +.Example: Display the logs of the `mypipelinerun` pipelinerun with all tasks and steps in a namespace +---- +$ tkn pipelinerun logs mypipeline -a -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-cli-reference.adoc b/modules/ROOT/pages/op-tkn-cli-reference.adoc new file mode 100644 index 00000000..0271b1f3 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-reference.adoc @@ -0,0 +1,25 @@ +[id='pipeline-cli-reference'] += Pipeline CLI reference +//include::modules/openshift-developer-cli-attributes.adoc[] +//include::modules/common-attributes.adoc[] +:context: pipeline-cli-reference +toc::[] + + +This section lists basic Tekton CLI commands. For a more detailed description, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI]. + +== Basic Syntax +`tkn [command or options] [arguments...]` + +== Global Options +`--help, -h` + +include::op-tkn-cli-utility-commands.adoc[leveloffset=+1] +include::op-tkn-cli-pipeline-management.adoc[leveloffset=+1] +include::op-tkn-cli-pipeline-run.adoc[leveloffset=+1] +include::op-tkn-cli-task-management.adoc[leveloffset=+1] +include::op-tkn-cli-task-run.adoc[leveloffset=+1] +include::op-tkn-cli-condition-management.adoc[leveloffset=+1] +include::op-tkn-cli-pipeline-resource-management.adoc[leveloffset=+1] +include::op-tkn-cli-clustertask-management.adoc[leveloffset=+1] +include::op-tkn-cli-trigger-management.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/op-tkn-cli-task-management.adoc b/modules/ROOT/pages/op-tkn-cli-task-management.adoc new file mode 100644 index 00000000..c5ed3da7 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-task-management.adoc @@ -0,0 +1,62 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-reference.adoc + +[id="cli-task-management-commands_{context}"] += Task Management Commands + +== tkn task +Manage tasks. + +.Example: Display help +---- +$ tkn task -h +---- + +== tkn task create +Create a task in a namespace. + +.Example: Create a task defined by the `mytask.yaml` file in a namespace +---- +$ tkn task create -f mytask.yaml -n myspace +---- + +== tkn task delete +Delete task resources in a namespace. + +.Example: Delete tasks from a namespace +---- +$ tkn task delete mytask1 mytask2 -n myspace +---- + +== tkn task describe +Describe a task in a namespace. + +.Example: Describe the `mytask` task in a namespace +---- +$ tkn task describe mytask -n myspace +---- + +== tkn task list +List tasks in a namespace. + +.Example: List all the tasks in a namespace +---- +$ tkn task list -n myspace +---- + +== tkn task logs +Display task logs. + +.Example: Display logs for the `mytaskrun` taskrun of the `mytask` task +---- +$ tkn task logs mytask mytaskrun -n myspace +---- + +== tkn task start +Start a task. + +.Example: Start the `mytask` task in a namespace +---- +$ tkn task start mytask -s -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-cli-task-run.adoc b/modules/ROOT/pages/op-tkn-cli-task-run.adoc new file mode 100644 index 00000000..8a07b110 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-task-run.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-reference.adoc + +[id="cli-task-run-commands_{context}"] += Task Run Commands + +== tkn taskrun +Manage taskruns. + +.Example: Display help +---- +$ tkn taskrun -h +---- + +== tkn taskrun cancel +Cancel a taskrun in a namespace. + +.Example: Cancel the `mytaskrun` taskrun from a namespace +---- +$ tkn taskrun cancel mytaskrun -n myspace +---- + +== tkn taskrun delete +Delete taskruns in a namespace. + +.Example: Delete `mytaskrun1` and `mytaskrun2` taskruns from a namespace +---- +$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace +---- + +== tkn taskrun describe +Describe a taskrun in a namespace. + +.Example: Describe the `mytaskrun` taskrun in a namespace +---- +$ tkn taskrun describe mytaskrun -n myspace +---- + +== tkn taskrun list +List taskruns in a namespace. + +.Example: List all taskruns in a namespace +---- +$ tkn taskrun list -n myspace +---- + + +== tkn taskrun logs +Display taskruns logs. + +.Example: Display live logs for the `mytaskrun` taskrun in a namespace ` + +---- +$ tkn taskrun logs -f mytaskrun -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc b/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc new file mode 100644 index 00000000..0c74cfad --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc @@ -0,0 +1,77 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-reference.adoc + +[id="cli-trigger-management-commands_{context}"] += Trigger Management Commands + +== tkn eventlistener +Manage event listeners. + +.Example: Display help +---- +$ tkn eventlistener -h +---- + +== tkn eventlistener delete +Delete event listeners in a namespace. + +.Example: Delete `mylistener1` and `mylistener2` event listeners in a namespace +---- +$ tkn eventlistener delete mylistener1 mylistener2 -n myspace +---- + +== tkn eventlistener list +Lists event listeners in a namespace. + +.Example: List all event listeners in a namespace +---- +$ tkn eventlistener list -n myspace +---- + +== tkn triggerbinding +Manage trigger bindings. + +.Example: Display trigger bindings help +---- +$ tkn triggerbinding -h +---- + +== tkn triggerbinding delete +Delete trigger bindings in a namespace. + +.Example: Delete `mybinding1` and `mybinding2` trigger bindings in a namespace +---- +$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace +---- + +== tkn triggerbinding list +List trigger bindings in a namespace. + +.Example: List all trigger bindings in a namespace +---- +$ tkn triggerbinding list -n myspace +---- + +== tkn triggertemplate +Manage trigger templates. + +.Example: Display trigger template help +---- +$ tkn triggertemplate -h +---- +== tkn triggertemplate delete +Delete trigger template in a namespace. + +.Example: Delete `mytemplate1` and `mytemplate2` trigger template in a namespace +---- +$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace` +---- + +== tkn triggertemplate list +Lists trigger templates in a namespace. + +.Example: List all trigger templates in a namespace +---- +$ tkn triggertemplate list -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc b/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc new file mode 100644 index 00000000..b07f795b --- /dev/null +++ b/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-cli-reference.adoc + +[id="cli-utility-commands_{context}"] += Utility Commands + +== tkn +Parent command for Tekton CLI. + +.Example:Display all options +----- +$ tkn +----- + +== tkn completion [shell] +Print shell completion code which must be evaluated to provide interactive completion. Supported shells are `bash` and `zsh`. + +.Example: Completion code for `bash` shell +---- +$ tkn completion bash +---- + +== tkn version +Print version information of the Tekton CLI `tkn`. + +.Example: Check for the newer version availability +----- +$ tkn version -c +----- diff --git a/modules/ROOT/pages/ref_cli-reference.adoc b/modules/ROOT/pages/ref_cli-reference.adoc deleted file mode 100644 index 3ab02ff1..00000000 --- a/modules/ROOT/pages/ref_cli-reference.adoc +++ /dev/null @@ -1,85 +0,0 @@ -[id="basic-tekton-cli-commands_{context}"] -= Basic Tekton CLI commands - -This section lists basic Tekton CLI commands. For a more detailed desciption, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI]. - -== Syntax -`tkn [command or options] [arguments...]` - -== Global Options -`--help, -h` - -== Utility commands - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn.md[tkn] -Parent command for Tekton CLI. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_completion.md[tkn completion] -Prints shell completion scripts. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_version.md[tkn version] -Prints version information. - -== Managing and running pipelines -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline.md[tkn pipeline] -Manages pipelines. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_describe.md[tkn pipeline describe] -Describes a pipeline in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_list.md[tkn pipeline list] -Lists pipelines in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_logs.md[tkn pipeline logs] -Shows pipeline logs. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_start.md[tkn pipeline start] -Starts pipelines. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun.md[tkn pipelinerun] -Manages pipelineruns. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun_describe.md[tkn pipelinerun describe] -Describes a pipelinerun in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun_list.md[tkn pipelinerun list] -Lists pipelineruns in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun_logs.md[tkn pipelinerun logs] -Shows pipelinerun logs. - -== Managing pipeline resources - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_resource.md[tkn resource] -Manages pipeline resources. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_resource_describe.md[tkn resource describe] -Describes a pipeline resource in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_resource_list.md[tkn resource list] -Lists pipeline resources in a namespace. - -== Managing and running tasks - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_task.md[tkn task] -Manages tasks. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_task_list.md[tkn task list] -Lists tasks in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_taskrun.md[tkn taskrun] -Manages taskruns. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_taskrun_list.md[tkn taskrun list] -Lists taskruns in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_taskrun_logs.md[tkn taskrun logs] -Shows taskruns logs. - -== Managing clusters - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_clustertask.md[tkn clustertask] -Manages clustertasks. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_clustertask_list.md[tkn clustertask list] -Lists clustertasks in a namespace. From 4514c137ef443e928feb693e99eb95224c4668b6 Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Sat, 7 Mar 2020 01:46:16 +0530 Subject: [PATCH 2/6] Review comments Fixed --- modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc | 2 +- modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc | 4 ++-- modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc | 2 +- modules/ROOT/pages/op-tkn-cli-task-management.adoc | 2 +- modules/ROOT/pages/op-tkn-cli-task-run.adoc | 2 +- modules/ROOT/pages/op-tkn-cli-utility-commands.adoc | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc b/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc index df34cd75..9dcf18b9 100644 --- a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc @@ -23,7 +23,7 @@ $ tkn clustertask delete mytask1 mytask2 == tkn clustertask describe -Describes a clustertask. +Describe a clustertask. .Example: Describe the `mytask` clustertask ---- diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc index 60d6c3ce..664bc394 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc @@ -47,7 +47,7 @@ $ tkn pipeline list ----- == tkn pipeline logs -Display pipeline logs for a specific pipeline . +Display pipeline logs for a specific pipeline. .Example: Stream live logs for the `mypipeline` pipeline ---- @@ -57,7 +57,7 @@ $ tkn pipeline logs -f mypipeline == tkn pipeline start Start a pipeline. -.Example: Start a pipeline +.Example: Start `mypipeline` pipeline ---- $ tkn pipeline start mypipeline ---- diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc index 6823e914..84fb446c 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-references.adoc [id="cli-pipeline-run-commands_{context}"] -= Pipelines Run Commands += PipelinesRun Commands == tkn pipelinerun diff --git a/modules/ROOT/pages/op-tkn-cli-task-management.adoc b/modules/ROOT/pages/op-tkn-cli-task-management.adoc index c5ed3da7..3955d9f5 100644 --- a/modules/ROOT/pages/op-tkn-cli-task-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-task-management.adoc @@ -24,7 +24,7 @@ $ tkn task create -f mytask.yaml -n myspace == tkn task delete Delete task resources in a namespace. -.Example: Delete tasks from a namespace +.Example: Delete `mytask1` and `mytask2` tasks from a namespace ---- $ tkn task delete mytask1 mytask2 -n myspace ---- diff --git a/modules/ROOT/pages/op-tkn-cli-task-run.adoc b/modules/ROOT/pages/op-tkn-cli-task-run.adoc index 8a07b110..0b704c64 100644 --- a/modules/ROOT/pages/op-tkn-cli-task-run.adoc +++ b/modules/ROOT/pages/op-tkn-cli-task-run.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-task-run-commands_{context}"] -= Task Run Commands += TaskRun Commands == tkn taskrun Manage taskruns. diff --git a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc b/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc index b07f795b..3f6565f0 100644 --- a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc +++ b/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc @@ -24,7 +24,7 @@ $ tkn completion bash == tkn version Print version information of the Tekton CLI `tkn`. -.Example: Check for the newer version availability +.Example: Check for the availability of a newer version ----- $ tkn version -c ----- From 61657abb6f11203503598f006ecd624229566169 Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Sun, 8 Mar 2020 09:01:02 +0530 Subject: [PATCH 3/6] Review comments plus few more heading changes --- modules/ROOT/nav.adoc | 22 +++++++++---------- .../op-tkn-cli-clustertask-management.adoc | 2 +- .../op-tkn-cli-condition-management.adoc | 2 +- .../pages/op-tkn-cli-pipeline-management.adoc | 2 +- ...-tkn-cli-pipeline-resource-management.adoc | 2 +- .../ROOT/pages/op-tkn-cli-pipeline-run.adoc | 2 +- .../pages/op-tkn-cli-task-management.adoc | 2 +- modules/ROOT/pages/op-tkn-cli-task-run.adoc | 2 +- .../pages/op-tkn-cli-trigger-management.adoc | 2 +- .../pages/op-tkn-cli-utility-commands.adoc | 2 +- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 065dee31..4e22c1e5 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -20,16 +20,16 @@ ** xref:proc_creating-applications-with-cicd-pipelines.adoc[4.1 Creating-applications with CI/CD pipelines] ** xref:proc_interacting-with-pipelines-using-the-developer-perspective.adoc[4.2 Interacting with pipelines using the Developer perspective] * xref:assembly_cli-reference.adoc[5. CLI Reference] -** xref:proc_installing-cli.adoc[5.1 Installing CLI] -** xref:op-tkn-cli-reference.adoc[5.2 Basic Commands] -*** xref:op-tkn-cli-utility-commands.adoc[5.2.1 Utility Commands] -*** xref:op-tkn-cli-pipeline-management.adoc[5.2.2 Pipeline Management Commands] -*** xref:op-tkn-cli-pipeline-run.adoc[5.2.3 Pipeline Run Commands] -*** xref:op-tkn-cli-task-management.adoc[5.2.4 Task Management Commands] -*** xref:op-tkn-cli-task-run.adoc[5.2.5 Task Run Commands] -*** xref:op-tkn-cli-condition-management.adoc[5.2.6 Condition Management Commands] -*** xref:op-tkn-cli-pipeline-resource-management.adoc[5.2.7 Pipeline Resource Management Commands] -*** xref:op-tkn-cli-clustertask-management.adoc[5.2.8 Clustertask Management Commands] -*** xref:op-tkn-cli-trigger-management.adoc[[5.2.9 Trigger Management Commands] +** xref:proc_installing-cli.adoc[5.1 Installing tkn] +** xref:op-tkn-cli-reference.adoc[5.2 Basic tkn commands] +*** xref:op-tkn-cli-utility-commands.adoc[5.2.1 Utility commands] +*** xref:op-tkn-cli-pipeline-management.adoc[5.2.2 Pipeline management commands] +*** xref:op-tkn-cli-pipeline-run.adoc[5.2.3 Pipelinerun commands] +*** xref:op-tkn-cli-task-management.adoc[5.2.4 Task management commands] +*** xref:op-tkn-cli-task-run.adoc[5.2.5 Taskrun commands] +*** xref:op-tkn-cli-condition-management.adoc[5.2.6 Condition management commands] +*** xref:op-tkn-cli-pipeline-resource-management.adoc[5.2.7 Pipeline resource management commands] +*** xref:op-tkn-cli-clustertask-management.adoc[5.2.8 Clustertask management commands] +*** xref:op-tkn-cli-trigger-management.adoc[[5.2.9 Trigger management commands] * xref:release_notes.adoc[Release Notes] diff --git a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc b/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc index 9dcf18b9..98314dbc 100644 --- a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-clustertask-management-commands_{context}"] -= Clustertask Management Commands += Clustertask management commands == tkn clustertask Manage clustertasks. diff --git a/modules/ROOT/pages/op-tkn-cli-condition-management.adoc b/modules/ROOT/pages/op-tkn-cli-condition-management.adoc index 6526a9f6..20ae7931 100644 --- a/modules/ROOT/pages/op-tkn-cli-condition-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-condition-management.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-references.adoc [id="cli-condition-management-commands_{context}"] -= Condition Management Commands += Condition management commands == tkn condition Manage conditions. diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc index 664bc394..b36373c1 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-references.adoc [id="cli-pipeline-management-commands_{context}"] -= Pipelines Management Commands += Pipelines management commands == tkn pipeline Manage pipelines. diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc index 79e7bb0b..052a1146 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-pipeline-resources-management-commands_{context}"] -= Pipeline Resource Management Commands += Pipeline resource management commands == tkn resource Manage pipeline resources. diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc b/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc index 84fb446c..0275fa11 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc +++ b/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-references.adoc [id="cli-pipeline-run-commands_{context}"] -= PipelinesRun Commands += Pipelinerun commands == tkn pipelinerun diff --git a/modules/ROOT/pages/op-tkn-cli-task-management.adoc b/modules/ROOT/pages/op-tkn-cli-task-management.adoc index 3955d9f5..e2b243eb 100644 --- a/modules/ROOT/pages/op-tkn-cli-task-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-task-management.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-task-management-commands_{context}"] -= Task Management Commands += Task management commands == tkn task Manage tasks. diff --git a/modules/ROOT/pages/op-tkn-cli-task-run.adoc b/modules/ROOT/pages/op-tkn-cli-task-run.adoc index 0b704c64..cf83808a 100644 --- a/modules/ROOT/pages/op-tkn-cli-task-run.adoc +++ b/modules/ROOT/pages/op-tkn-cli-task-run.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-task-run-commands_{context}"] -= TaskRun Commands += Taskrun commands == tkn taskrun Manage taskruns. diff --git a/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc b/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc index 0c74cfad..c22b8923 100644 --- a/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc +++ b/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-trigger-management-commands_{context}"] -= Trigger Management Commands += Trigger management commands == tkn eventlistener Manage event listeners. diff --git a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc b/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc index 3f6565f0..19fee329 100644 --- a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc +++ b/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc @@ -3,7 +3,7 @@ // * pipelines/op-tkn-cli-reference.adoc [id="cli-utility-commands_{context}"] -= Utility Commands += Utility commands == tkn Parent command for Tekton CLI. From cdee148bef2c9f3cfe23ca888ced4a4f54f45c39 Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Mon, 16 Mar 2020 09:47:47 +0530 Subject: [PATCH 4/6] CLI Comments Incorporated-All file names modified to remove CLI --- modules/ROOT/nav.adoc | 20 +++++++-------- .../ROOT/pages/assembly_cli-reference.adoc | 2 +- modules/ROOT/pages/op-tkn-cli-reference.adoc | 25 ------------------- ...doc => op-tkn-clustertask-management.adoc} | 4 +-- ....adoc => op-tkn-condition-management.adoc} | 4 +-- ...t.adoc => op-tkn-pipeline-management.adoc} | 4 +-- ... op-tkn-pipeline-resource-management.adoc} | 4 +-- ...line-run.adoc => op-tkn-pipeline-run.adoc} | 4 +-- modules/ROOT/pages/op-tkn-reference.adoc | 24 ++++++++++++++++++ ...ement.adoc => op-tkn-task-management.adoc} | 4 +-- ...cli-task-run.adoc => op-tkn-task-run.adoc} | 4 +-- ...nt.adoc => op-tkn-trigger-management.adoc} | 8 +++--- ...ands.adoc => op-tkn-utility-commands.adoc} | 8 +++--- 13 files changed, 57 insertions(+), 58 deletions(-) delete mode 100644 modules/ROOT/pages/op-tkn-cli-reference.adoc rename modules/ROOT/pages/{op-tkn-cli-clustertask-management.adoc => op-tkn-clustertask-management.adoc} (89%) rename modules/ROOT/pages/{op-tkn-cli-condition-management.adoc => op-tkn-condition-management.adoc} (84%) rename modules/ROOT/pages/{op-tkn-cli-pipeline-management.adoc => op-tkn-pipeline-management.adoc} (92%) rename modules/ROOT/pages/{op-tkn-cli-pipeline-resource-management.adoc => op-tkn-pipeline-resource-management.adoc} (90%) rename modules/ROOT/pages/{op-tkn-cli-pipeline-run.adoc => op-tkn-pipeline-run.adoc} (93%) create mode 100644 modules/ROOT/pages/op-tkn-reference.adoc rename modules/ROOT/pages/{op-tkn-cli-task-management.adoc => op-tkn-task-management.adoc} (92%) rename modules/ROOT/pages/{op-tkn-cli-task-run.adoc => op-tkn-task-run.adoc} (92%) rename modules/ROOT/pages/{op-tkn-cli-trigger-management.adoc => op-tkn-trigger-management.adoc} (91%) rename modules/ROOT/pages/{op-tkn-cli-utility-commands.adoc => op-tkn-utility-commands.adoc} (73%) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 4e22c1e5..32e9c934 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -21,15 +21,15 @@ ** xref:proc_interacting-with-pipelines-using-the-developer-perspective.adoc[4.2 Interacting with pipelines using the Developer perspective] * xref:assembly_cli-reference.adoc[5. CLI Reference] ** xref:proc_installing-cli.adoc[5.1 Installing tkn] -** xref:op-tkn-cli-reference.adoc[5.2 Basic tkn commands] -*** xref:op-tkn-cli-utility-commands.adoc[5.2.1 Utility commands] -*** xref:op-tkn-cli-pipeline-management.adoc[5.2.2 Pipeline management commands] -*** xref:op-tkn-cli-pipeline-run.adoc[5.2.3 Pipelinerun commands] -*** xref:op-tkn-cli-task-management.adoc[5.2.4 Task management commands] -*** xref:op-tkn-cli-task-run.adoc[5.2.5 Taskrun commands] -*** xref:op-tkn-cli-condition-management.adoc[5.2.6 Condition management commands] -*** xref:op-tkn-cli-pipeline-resource-management.adoc[5.2.7 Pipeline resource management commands] -*** xref:op-tkn-cli-clustertask-management.adoc[5.2.8 Clustertask management commands] -*** xref:op-tkn-cli-trigger-management.adoc[[5.2.9 Trigger management commands] +** xref:op-tkn-reference.adoc[5.2 Basic tkn commands] +*** xref:op-tkn-utility-commands.adoc[5.2.1 Utility commands] +*** xref:op-tkn-pipeline-management.adoc[5.2.2 Pipeline management commands] +*** xref:op-tkn-pipeline-run.adoc[5.2.3 Pipelinerun commands] +*** xref:op-tkn-task-management.adoc[5.2.4 Task management commands] +*** xref:op-tkn-task-run.adoc[5.2.5 Taskrun commands] +*** xref:op-tkn-condition-management.adoc[5.2.6 Condition management commands] +*** xref:op-tkn-pipeline-resource-management.adoc[5.2.7 Pipeline resource management commands] +*** xref:op-tkn-clustertask-management.adoc[5.2.8 Clustertask management commands] +*** xref:op-tkn-trigger-management.adoc[5.2.9 Trigger management commands] * xref:release_notes.adoc[Release Notes] diff --git a/modules/ROOT/pages/assembly_cli-reference.adoc b/modules/ROOT/pages/assembly_cli-reference.adoc index 650f7ac3..4226436d 100644 --- a/modules/ROOT/pages/assembly_cli-reference.adoc +++ b/modules/ROOT/pages/assembly_cli-reference.adoc @@ -5,7 +5,7 @@ :context: cli-reference -With the Tekton Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands. +With the Tekton (tkn) Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands. // CLI Installation Guide diff --git a/modules/ROOT/pages/op-tkn-cli-reference.adoc b/modules/ROOT/pages/op-tkn-cli-reference.adoc deleted file mode 100644 index 0271b1f3..00000000 --- a/modules/ROOT/pages/op-tkn-cli-reference.adoc +++ /dev/null @@ -1,25 +0,0 @@ -[id='pipeline-cli-reference'] -= Pipeline CLI reference -//include::modules/openshift-developer-cli-attributes.adoc[] -//include::modules/common-attributes.adoc[] -:context: pipeline-cli-reference -toc::[] - - -This section lists basic Tekton CLI commands. For a more detailed description, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI]. - -== Basic Syntax -`tkn [command or options] [arguments...]` - -== Global Options -`--help, -h` - -include::op-tkn-cli-utility-commands.adoc[leveloffset=+1] -include::op-tkn-cli-pipeline-management.adoc[leveloffset=+1] -include::op-tkn-cli-pipeline-run.adoc[leveloffset=+1] -include::op-tkn-cli-task-management.adoc[leveloffset=+1] -include::op-tkn-cli-task-run.adoc[leveloffset=+1] -include::op-tkn-cli-condition-management.adoc[leveloffset=+1] -include::op-tkn-cli-pipeline-resource-management.adoc[leveloffset=+1] -include::op-tkn-cli-clustertask-management.adoc[leveloffset=+1] -include::op-tkn-cli-trigger-management.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc b/modules/ROOT/pages/op-tkn-clustertask-management.adoc similarity index 89% rename from modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc rename to modules/ROOT/pages/op-tkn-clustertask-management.adoc index 98314dbc..8270ead9 100644 --- a/modules/ROOT/pages/op-tkn-cli-clustertask-management.adoc +++ b/modules/ROOT/pages/op-tkn-clustertask-management.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-reference.adoc +// * pipelines/op-tkn-reference.adoc -[id="cli-clustertask-management-commands_{context}"] +[id="tkn-clustertask-management-commands_{context}"] = Clustertask management commands == tkn clustertask diff --git a/modules/ROOT/pages/op-tkn-cli-condition-management.adoc b/modules/ROOT/pages/op-tkn-condition-management.adoc similarity index 84% rename from modules/ROOT/pages/op-tkn-cli-condition-management.adoc rename to modules/ROOT/pages/op-tkn-condition-management.adoc index 20ae7931..4afc81b1 100644 --- a/modules/ROOT/pages/op-tkn-cli-condition-management.adoc +++ b/modules/ROOT/pages/op-tkn-condition-management.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-references.adoc +// * pipelines/op-tkn-references.adoc -[id="cli-condition-management-commands_{context}"] +[id="tkn-condition-management-commands_{context}"] = Condition management commands == tkn condition diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc b/modules/ROOT/pages/op-tkn-pipeline-management.adoc similarity index 92% rename from modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc rename to modules/ROOT/pages/op-tkn-pipeline-management.adoc index b36373c1..a6e785db 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-management.adoc +++ b/modules/ROOT/pages/op-tkn-pipeline-management.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-references.adoc +// * pipelines/op-tkn-references.adoc -[id="cli-pipeline-management-commands_{context}"] +[id="tkn-pipeline-management-commands_{context}"] = Pipelines management commands == tkn pipeline diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc b/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc similarity index 90% rename from modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc rename to modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc index 052a1146..4ef29c43 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-resource-management.adoc +++ b/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-reference.adoc +// * pipelines/op-tkn-reference.adoc -[id="cli-pipeline-resources-management-commands_{context}"] +[id="tkn-pipeline-resources-management-commands_{context}"] = Pipeline resource management commands == tkn resource diff --git a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc b/modules/ROOT/pages/op-tkn-pipeline-run.adoc similarity index 93% rename from modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc rename to modules/ROOT/pages/op-tkn-pipeline-run.adoc index 0275fa11..be9f6421 100644 --- a/modules/ROOT/pages/op-tkn-cli-pipeline-run.adoc +++ b/modules/ROOT/pages/op-tkn-pipeline-run.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-references.adoc +// * pipelines/op-tkn-references.adoc -[id="cli-pipeline-run-commands_{context}"] +[id="tkn-pipeline-run-commands_{context}"] = Pipelinerun commands diff --git a/modules/ROOT/pages/op-tkn-reference.adoc b/modules/ROOT/pages/op-tkn-reference.adoc new file mode 100644 index 00000000..9f4b14b5 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-reference.adoc @@ -0,0 +1,24 @@ +[id='pipeline-tkn-reference'] += Pipeline `tkn` reference +//include::modules/common-attributes.adoc[] +:context: pipeline-tkn-reference +toc::[] + + +This section lists basic `tkn` CLI commands. For a more detailed description, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI]. + +== Basic Syntax +`tkn [command or options] [arguments...]` + +== Global Options +`--help, -h` + +include::op-tkn-utility-commands.adoc[leveloffset=+1] +include::op-tkn-pipeline-management.adoc[leveloffset=+1] +include::op-tkn-pipeline-run.adoc[leveloffset=+1] +include::op-tkn-task-management.adoc[leveloffset=+1] +include::op-tkn-task-run.adoc[leveloffset=+1] +include::op-tkn-condition-management.adoc[leveloffset=+1] +include::op-tkn-pipeline-resource-management.adoc[leveloffset=+1] +include::op-tkn-clustertask-management.adoc[leveloffset=+1] +include::op-tkn-trigger-management.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/op-tkn-cli-task-management.adoc b/modules/ROOT/pages/op-tkn-task-management.adoc similarity index 92% rename from modules/ROOT/pages/op-tkn-cli-task-management.adoc rename to modules/ROOT/pages/op-tkn-task-management.adoc index e2b243eb..10f99e82 100644 --- a/modules/ROOT/pages/op-tkn-cli-task-management.adoc +++ b/modules/ROOT/pages/op-tkn-task-management.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-reference.adoc +// * pipelines/op-tkn-reference.adoc -[id="cli-task-management-commands_{context}"] +[id="tkn-task-management-commands_{context}"] = Task management commands == tkn task diff --git a/modules/ROOT/pages/op-tkn-cli-task-run.adoc b/modules/ROOT/pages/op-tkn-task-run.adoc similarity index 92% rename from modules/ROOT/pages/op-tkn-cli-task-run.adoc rename to modules/ROOT/pages/op-tkn-task-run.adoc index cf83808a..d6c2ffac 100644 --- a/modules/ROOT/pages/op-tkn-cli-task-run.adoc +++ b/modules/ROOT/pages/op-tkn-task-run.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-reference.adoc +// * pipelines/op-tkn-reference.adoc -[id="cli-task-run-commands_{context}"] +[id="tkn-task-run-commands_{context}"] = Taskrun commands == tkn taskrun diff --git a/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc b/modules/ROOT/pages/op-tkn-trigger-management.adoc similarity index 91% rename from modules/ROOT/pages/op-tkn-cli-trigger-management.adoc rename to modules/ROOT/pages/op-tkn-trigger-management.adoc index c22b8923..65051182 100644 --- a/modules/ROOT/pages/op-tkn-cli-trigger-management.adoc +++ b/modules/ROOT/pages/op-tkn-trigger-management.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-reference.adoc +// * pipelines/op-tkn-reference.adoc -[id="cli-trigger-management-commands_{context}"] +[id="tkn-trigger-management-commands_{context}"] = Trigger management commands == tkn eventlistener @@ -61,9 +61,9 @@ Manage trigger templates. $ tkn triggertemplate -h ---- == tkn triggertemplate delete -Delete trigger template in a namespace. +Delete trigger templates in a namespace. -.Example: Delete `mytemplate1` and `mytemplate2` trigger template in a namespace +.Example: Delete `mytemplate1` and `mytemplate2` trigger templates in a namespace ---- $ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace` ---- diff --git a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc b/modules/ROOT/pages/op-tkn-utility-commands.adoc similarity index 73% rename from modules/ROOT/pages/op-tkn-cli-utility-commands.adoc rename to modules/ROOT/pages/op-tkn-utility-commands.adoc index 19fee329..b6d5873b 100644 --- a/modules/ROOT/pages/op-tkn-cli-utility-commands.adoc +++ b/modules/ROOT/pages/op-tkn-utility-commands.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * pipelines/op-tkn-cli-reference.adoc +// * pipelines/op-tkn-reference.adoc -[id="cli-utility-commands_{context}"] +[id="tkn-utility-commands_{context}"] = Utility commands == tkn -Parent command for Tekton CLI. +Parent command for `tkn` CLI. .Example:Display all options ----- @@ -22,7 +22,7 @@ $ tkn completion bash ---- == tkn version -Print version information of the Tekton CLI `tkn`. +Print version information of the `tkn` CLI. .Example: Check for the availability of a newer version ----- From 6c5c815b8c75a24adb3a979ac16e6436a854ac0a Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Mon, 23 Mar 2020 00:17:45 +0530 Subject: [PATCH 5/6] Id/Context names aligned with File names --- modules/ROOT/pages/op-tkn-clustertask-management.adoc | 2 +- modules/ROOT/pages/op-tkn-condition-management.adoc | 2 +- modules/ROOT/pages/op-tkn-pipeline-management.adoc | 2 +- modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc | 2 +- modules/ROOT/pages/op-tkn-pipeline-run.adoc | 2 +- modules/ROOT/pages/op-tkn-reference.adoc | 4 ++-- modules/ROOT/pages/op-tkn-task-management.adoc | 2 +- modules/ROOT/pages/op-tkn-task-run.adoc | 2 +- modules/ROOT/pages/op-tkn-trigger-management.adoc | 2 +- modules/ROOT/pages/op-tkn-utility-commands.adoc | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/ROOT/pages/op-tkn-clustertask-management.adoc b/modules/ROOT/pages/op-tkn-clustertask-management.adoc index 8270ead9..108aa1fb 100644 --- a/modules/ROOT/pages/op-tkn-clustertask-management.adoc +++ b/modules/ROOT/pages/op-tkn-clustertask-management.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-reference.adoc -[id="tkn-clustertask-management-commands_{context}"] +[id="op-tkn-clustertask-management-commands_{context}"] = Clustertask management commands == tkn clustertask diff --git a/modules/ROOT/pages/op-tkn-condition-management.adoc b/modules/ROOT/pages/op-tkn-condition-management.adoc index 4afc81b1..65deab80 100644 --- a/modules/ROOT/pages/op-tkn-condition-management.adoc +++ b/modules/ROOT/pages/op-tkn-condition-management.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-references.adoc -[id="tkn-condition-management-commands_{context}"] +[id="op-tkn-condition-management_{context}"] = Condition management commands == tkn condition diff --git a/modules/ROOT/pages/op-tkn-pipeline-management.adoc b/modules/ROOT/pages/op-tkn-pipeline-management.adoc index a6e785db..0901b26e 100644 --- a/modules/ROOT/pages/op-tkn-pipeline-management.adoc +++ b/modules/ROOT/pages/op-tkn-pipeline-management.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-references.adoc -[id="tkn-pipeline-management-commands_{context}"] +[id="op-tkn-pipeline-management_{context}"] = Pipelines management commands == tkn pipeline diff --git a/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc b/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc index 4ef29c43..799244cb 100644 --- a/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc +++ b/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-reference.adoc -[id="tkn-pipeline-resources-management-commands_{context}"] +[id="op-tkn-pipeline-resource-management_{context}"] = Pipeline resource management commands == tkn resource diff --git a/modules/ROOT/pages/op-tkn-pipeline-run.adoc b/modules/ROOT/pages/op-tkn-pipeline-run.adoc index be9f6421..808482de 100644 --- a/modules/ROOT/pages/op-tkn-pipeline-run.adoc +++ b/modules/ROOT/pages/op-tkn-pipeline-run.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-references.adoc -[id="tkn-pipeline-run-commands_{context}"] +[id="op-tkn-pipeline-run_{context}"] = Pipelinerun commands diff --git a/modules/ROOT/pages/op-tkn-reference.adoc b/modules/ROOT/pages/op-tkn-reference.adoc index 9f4b14b5..e4d4e7d3 100644 --- a/modules/ROOT/pages/op-tkn-reference.adoc +++ b/modules/ROOT/pages/op-tkn-reference.adoc @@ -1,7 +1,7 @@ -[id='pipeline-tkn-reference'] +[id='op-tkn-reference'] = Pipeline `tkn` reference //include::modules/common-attributes.adoc[] -:context: pipeline-tkn-reference +:context: op-tkn-reference toc::[] diff --git a/modules/ROOT/pages/op-tkn-task-management.adoc b/modules/ROOT/pages/op-tkn-task-management.adoc index 10f99e82..a1bc6b1f 100644 --- a/modules/ROOT/pages/op-tkn-task-management.adoc +++ b/modules/ROOT/pages/op-tkn-task-management.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-reference.adoc -[id="tkn-task-management-commands_{context}"] +[id="op-tkn-task-management_{context}"] = Task management commands == tkn task diff --git a/modules/ROOT/pages/op-tkn-task-run.adoc b/modules/ROOT/pages/op-tkn-task-run.adoc index d6c2ffac..fc52efb6 100644 --- a/modules/ROOT/pages/op-tkn-task-run.adoc +++ b/modules/ROOT/pages/op-tkn-task-run.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-reference.adoc -[id="tkn-task-run-commands_{context}"] +[id="op-tkn-task-run_{context}"] = Taskrun commands == tkn taskrun diff --git a/modules/ROOT/pages/op-tkn-trigger-management.adoc b/modules/ROOT/pages/op-tkn-trigger-management.adoc index 65051182..8b87f355 100644 --- a/modules/ROOT/pages/op-tkn-trigger-management.adoc +++ b/modules/ROOT/pages/op-tkn-trigger-management.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-reference.adoc -[id="tkn-trigger-management-commands_{context}"] +[id="op-tkn-trigger-management_{context}"] = Trigger management commands == tkn eventlistener diff --git a/modules/ROOT/pages/op-tkn-utility-commands.adoc b/modules/ROOT/pages/op-tkn-utility-commands.adoc index b6d5873b..e36f2700 100644 --- a/modules/ROOT/pages/op-tkn-utility-commands.adoc +++ b/modules/ROOT/pages/op-tkn-utility-commands.adoc @@ -2,7 +2,7 @@ // // * pipelines/op-tkn-reference.adoc -[id="tkn-utility-commands_{context}"] +[id="op-tkn-utility-commands_{context}"] = Utility commands == tkn From e30de425ff8e09d5afd8d8252dfafb480ed0d214 Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Mon, 23 Mar 2020 16:56:33 +0530 Subject: [PATCH 6/6] Minor changes --- modules/ROOT/pages/assembly_cli-reference.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/assembly_cli-reference.adoc b/modules/ROOT/pages/assembly_cli-reference.adoc index 4226436d..7c2502ff 100644 --- a/modules/ROOT/pages/assembly_cli-reference.adoc +++ b/modules/ROOT/pages/assembly_cli-reference.adoc @@ -13,7 +13,7 @@ include::proc_installing-cli.adoc[leveloffset=+1] // CLI Reference -include::op-tkn-cli-reference.adoc[leveloffset=+1] +include::op-tkn-reference.adoc[leveloffset=+1]