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.

Sign up for GitHub

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

Remove docs related to PipelineResource #2000

Merged
merged 1 commit into from
Apr 20, 2023
Merged

Remove docs related to PipelineResource #2000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,6 @@ The following commands help you understand and effectively use the Tekton CLI:
* [`tkn hub:`](docs/cmd/tkn_hub.md) Search and install Tekton Resources from [Hub](https://hub.tekton.dev)
* [`tkn pipeline:`](docs/cmd/tkn_pipeline.md) Parent command of the Pipeline command group.
* [`tkn pipelinerun:`](docs/cmd/tkn_pipelinerun.md) Parent command of the Pipelinerun command group.
* [`tkn resource:`](docs/cmd/tkn_resource.md) Parent command of the Resource command group.
* [`tkn task:`](docs/cmd/tkn_task.md) Parent command of the Task command group.
* [`tkn taskrun:`](docs/cmd/tkn_taskrun.md) Parent command of the Taskrun command group.
* [`tkn triggerbinding:`](docs/cmd/tkn_triggerbinding.md) Parent command of the Triggerbinding command group.
Expand Down
15 changes: 7 additions & 8 deletions docs/cmd/tkn_pipeline_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ tkn pipeline start

To start a pipeline, you will need to pass the following:

- Resources
- Workspaces
- Parameters, at least those that have no default value

### Examples

To run a Pipeline that has one git resource and no parameter.
To run a Pipeline that has one workspace and no parameter.

$ tkn pipeline start --resource source=samples-git
$ tkn pipeline start --workspace name=my-empty-dir,emptyDir=""


To create a workspace-template.yaml
Expand All @@ -44,13 +44,12 @@ To create a csi-template.yaml
EOF
```

To run a Pipeline that has one git resource, one image resource,
two parameters (foo and bar) and four workspaces (my-config, my-pvc,
my-secret, my-empty-dir and my-volume-claim-template)
To run a Pipeline that has two parameters (foo and bar) and
six workspaces (my-config, my-pvc, my-secret, my-empty-dir,
my-csi-template and my-volume-claim-template)


$ tkn pipeline start --resource source=samples-git \
--resource image=my-image \
$ tkn pipeline start \
--param foo=yay \
--param bar=10 \
--workspace name=my-secret,secret=secret-name \
Expand Down
34 changes: 0 additions & 34 deletions docs/cmd/tkn_resource.md
View file
Open in desktop

This file was deleted.

43 changes: 0 additions & 43 deletions docs/cmd/tkn_resource_create.md
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions docs/cmd/tkn_resource_delete.md
View file
Open in desktop

This file was deleted.

50 changes: 0 additions & 50 deletions docs/cmd/tkn_resource_describe.md
View file
Open in desktop

This file was deleted.

49 changes: 0 additions & 49 deletions docs/cmd/tkn_resource_list.md
View file
Open in desktop

This file was deleted.

15 changes: 7 additions & 8 deletions docs/man/man1/tkn-pipeline-start.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To start a pipeline, you will need to pass the following:

.RS
.IP \(bu 2
Resources
Workspaces
.IP \(bu 2
Parameters, at least those that have no default value

Expand Down Expand Up @@ -124,13 +124,13 @@ Parameters, at least those that have no default value

.SH EXAMPLE
.PP
To run a Pipeline that has one git resource and no parameter.
To run a Pipeline that has one workspace and no parameter.

.PP
.RS

.nf
$ tkn pipeline start \-\-resource source=samples\-git
$ tkn pipeline start \-\-workspace name=my\-empty\-dir,emptyDir=""

.fi
.RE
Expand Down Expand Up @@ -174,16 +174,15 @@ EOF
.RE

.PP
To run a Pipeline that has one git resource, one image resource,
two parameters (foo and bar) and four workspaces (my\-config, my\-pvc,
my\-secret, my\-empty\-dir and my\-volume\-claim\-template)
To run a Pipeline that has two parameters (foo and bar) and
six workspaces (my\-config, my\-pvc, my\-secret, my\-empty\-dir,
my\-csi\-template and my\-volume\-claim\-template)

.PP
.RS

.nf
$ tkn pipeline start \-\-resource source=samples\-git \\
\-\-resource image=my\-image \\
$ tkn pipeline start \\
\-\-param foo=yay \\
\-\-param bar=10 \\
\-\-workspace name=my\-secret,secret=secret\-name \\
Expand Down
Loading