Skip to content

Commit

Permalink
Add the information regarding docs
Browse files Browse the repository at this point in the history
This will add the information regarding generating
and updating docs(markdown and man pages) in the PR

Also updated the docs according to current master
  • Loading branch information
piyush-garg authored and tekton-robot committed Aug 22, 2019
1 parent 16023ac commit 733a0d4
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 4 deletions.
18 changes: 17 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ While iterating on the project, you may need to:

1. [Install Tekton pipeline](#install-pipeline)
2. [Building Tekton client](#building-tekton-client)
1. [Add and run tests](./test/README.md#tests)
3. [Add and run tests](./test/README.md#tests)
4. [Generate docs](#generate-docs)

## Building Tekton client

Expand Down Expand Up @@ -136,6 +137,21 @@ GO111MODULE=on go build ./cmd/tkn
You can now try updating code for client and test out the changes by building the `tkn` binary.


## Generate Docs

The docs are autogenerated according to cobra command. Whenever you are updating any command configuration,
you should also update the docs in the PR.

- To generate/update markdown pages
```sh
make docs
```

- To generate/update man pages
```sh
make man
```

## Install Pipeline

You can stand up a version of this controller on-cluster (to your
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_pipeline_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Show pipeline logs

# show logs for given pipeline and pipelinerun
tkn pipeline logs pipeline run -n namespace



### Options
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_pipelinerun_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Show the logs of PipelineRun
# show the logs of PipelineRun named "microservice-1" for task "build" only, from the 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),
# show the logs of PipelineRun named "microservice-1" for all tasks and steps (including init steps),
from the namespace "foo"
tkn pr logs microservice-1 -a -n foo

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_taskrun_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Show taskruns logs
# show the logs of TaskRun named "foo" from the namespace "bar"
tkn taskrun logs foo -n bar

# show the live logs of TaskRun named "foo" from the namespace "bar"
# show the live logs of TaskRun named "foo" from the namespace "bar"
tkn taskrun logs -f foo -n bar


Expand Down

0 comments on commit 733a0d4

Please sign in to comment.