Skip to content

Commit

Permalink
fix(typo): fix typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FogDong authored and tekton-robot committed Aug 17, 2020
1 parent 8f58604 commit ce7591a
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Then you can [iterate](#iterating) (including

Welcome to the project!! You may find these resources helpful to ramp up on some
of the technology this project is built on. This project extends Kubernetes (aka
`k8s`) with Custom Resource Definitions (CRDSs). To find out more:
`k8s`) with Custom Resource Definitions (CRDs). To find out more:

- [The Kubernetes docs on Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) -
These will orient you on what words like "Resource" and "Controller"
Expand Down
2 changes: 1 addition & 1 deletion docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ Kubernetes `Secrets`.
- Associate the `ServiceAccount` with your `TaskRun`:

```yaml
apiVersion: tetkon.dev/v1beta1
apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
name: build-with-basic-auth
Expand Down
2 changes: 1 addition & 1 deletion docs/conditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ branch name doesn't collide with any of the specified protected branch names.

### Specifying `Resources`

You can specifiy input [`PipelineResources`](resources.md) in your `Condition` definition to
You can specify input [`PipelineResources`](resources.md) in your `Condition` definition to
provide the `Condition's` container step with data or context necessary to run the evaluation logic.

`Resources` in `Conditions` behave the same way as in `Tasks`:
Expand Down
2 changes: 1 addition & 1 deletion docs/container-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ controller performs an anonymous lookup of the image.
For example, consider the following `Task`, which uses two images named
`gcr.io/cloud-builders/gcloud` and `gcr.io/cloud-builders/docker`. In this example, the
Pipelines controller retrieves the `entrypoint` value from the registry, which allows
the `Task` to execute the `gcloud` and `docker` commmands, respectively.
the `Task` to execute the `gcloud` and `docker` commands, respectively.

```yaml
spec:
Expand Down
4 changes: 2 additions & 2 deletions docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ events as described in the table below.
Resource |Event |Event Type
:-------------|:-------:|:----------------------------------------------------------
`TaskRun` | `Started` | `dev.tekton.event.taskrun.started.v1`
`TaskRun` | `Running` | `dev.tekton.event.taskrun.runnning.v1`
`TaskRun` | `Running` | `dev.tekton.event.taskrun.running.v1`
`TaskRun` | `Condition Change while Running` | `dev.tekton.event.taskrun.unknown.v1`
`TaskRun` | `Succeed` | `dev.tekton.event.taskrun.successful.v1`
`TaskRun` | `Failed` | `dev.tekton.event.taskrun.failed.v1`
`PipelineRun` | `Started` | `dev.tekton.event.pipelinerun.started.v1`
`PipelineRun` | `Running` | `dev.tekton.event.pipelinerun.runnning.v1`
`PipelineRun` | `Running` | `dev.tekton.event.pipelinerun.running.v1`
`PipelineRun` | `Condition Change while Running` | `dev.tekton.event.pipelinerun.unknown.v1`
`PipelineRun` | `Succeed` | `dev.tekton.event.pipelinerun.successful.v1`
`PipelineRun` | `Failed` | `dev.tekton.event.pipelinerun.failed.v1`
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ data:
When configured so, Tekton can generate `CloudEvents` for `TaskRun` and `PipelineRun` lifecycle
events. The only configuration parameter is the URL of the sink. When not set, no notification is
generared.
generated.
```
apiVersion: v1
Expand Down
4 changes: 2 additions & 2 deletions docs/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ as its input, use the optional `from` parameter to specify a list of `Tasks`
that must execute **before** the `Task` that requires their outputs as its
input. When your target `Task` executes, only the version of the desired
`PipelineResource` produced by the last `Task` in this list is used. The
`name` of this output `PipelineReource` output must match the `name` of the
`name` of this output `PipelineResource` output must match the `name` of the
input `PipelineResource` specified in the `Task` that ingests it.

In the example below, the `deploy-app` `Task` ingests the output of the `build-app`
Expand Down Expand Up @@ -299,7 +299,7 @@ should retry its execution when it fails. When a `Task` fails, the corresponding
instructs Tekton to retry executing the `Task` when this happens.

If you expect a `Task` to encounter problems during execution (for example,
you know that there will be issues with network connectivitity or missing
you know that there will be issues with network connectivity or missing
dependencies), set its `retries` parameter to a suitable value greater than 0.
If you don't explicitly specify a value, Tekton does not attempt to execute
the failed `Task` again.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -1115,7 +1115,7 @@ They also present challenges from a documentation perspective:
So what are PipelineResources still good for? We think we've identified some of the most important things:

1. You can augment `Task`-only workflows with `PipelineResources` that, without them, can only be done with `Pipelines`.
- For example, let's say you want to checkout a git repo for your Task to test. You have two options. First, you could use a `git` PipelineResource and add it directly to your test `Task`. Second, you could write a `Pipeline` that has a `git-clone` `Task` which checks out the code onto a PersistentVolumeClaim `workspace` and then passes that PVC `workspace` to your test `Task`. For a lot of users the second workflow is totally acceptable but for others it isn't. Some of the most noteable reasons we've heard are:
- For example, let's say you want to checkout a git repo for your Task to test. You have two options. First, you could use a `git` PipelineResource and add it directly to your test `Task`. Second, you could write a `Pipeline` that has a `git-clone` `Task` which checks out the code onto a PersistentVolumeClaim `workspace` and then passes that PVC `workspace` to your test `Task`. For a lot of users the second workflow is totally acceptable but for others it isn't. Some of the most notable reasons we've heard are:
- Some users simply cannot allocate storage on their platform, meaning `PersistentVolumeClaims` are out of the question.
- Expanding a single `Task` workflow into a `Pipeline` is labor-intensive and feels unnecessary.
2. Despite being difficult to explain the whole CRD clearly each individual `type` is relatively easy to explain.
Expand Down
2 changes: 1 addition & 1 deletion docs/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 15
-->
# Variable Substitutions Supported by `Tasks` and `Pipelines`

This page documents the variable substitions supported by `Tasks` and `Pipelines`.
This page documents the variable substitutions supported by `Tasks` and `Pipelines`.

## Variables available in a `Pipeline`

Expand Down
6 changes: 3 additions & 3 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Tekton:
- [Alternative Task Implementations](https://github.com/tektoncd/pipeline/issues/215)
- [Local Execution](https://github.com/tektoncd/pipeline/issues/235)
- [Testing](https://github.com/tektoncd/pipeline/issues/1289) and [debugging](https://github.com/tektoncd/pipeline/issues/2069) frameworks
- [Emiting events throughout `Pipeline`
- [Emitting events throughout `Pipeline`
execution](https://github.com/tektoncd/pipeline/issues/2082)
- [Config as code](https://github.com/tektoncd/pipeline/issues/859) - This has some cross
over with [a related Triggers issue](https://github.com/tektoncd/triggers/issues/189)
Expand All @@ -50,7 +50,7 @@ Tekton:

In early 2020 we will have our first beta release, however
[it will be only for a subset of Pipeline's resources](https://docs.google.com/document/d/1H8I2Rk4kLdQaR4mV0A71Qbk-1FxXFrmvisEAjLKT6H0/edit#heading=h.t0sc4hdrr5yq).
After the intial beta release, we would like to get the rest of the resources to beta
After the initial beta release, we would like to get the rest of the resources to beta
as well.

## Task Interfaces and PipelineResources
Expand All @@ -76,7 +76,7 @@ https://github.com/tektoncd/pipeline/tree/master/cmd.

SCM support in 2019 was handled by
[the PullRequest Resource](https://github.com/tektoncd/pipeline/blob/master/docs/resources.md#pull-request-resource).
However [we are revisting PipelineResources](#task-interfaces-and-pipelineresources),
However [we are revisiting PipelineResources](#task-interfaces-and-pipelineresources),
and likely this `PipelineResource` will become one or more `Tasks` in
[the catalog](https://github.com/tektoncd/catalog) instead. Once that happens,
we will need to make decisions about how to release and maintain the
Expand Down

0 comments on commit ce7591a

Please sign in to comment.