Skip to content

Commit 530de18

Browse files
mattmoor-sockpuppettekton-robot
authored andcommitted
Format markdown
Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
1 parent a572137 commit 530de18

File tree

5 files changed

+45
-30
lines changed

5 files changed

+45
-30
lines changed

CONTRIBUTING.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,22 @@ our project and we hope you'll enjoy it :D
88

99
To get started developing, see our [DEVELOPMENT.md](./DEVELOPMENT.md).
1010

11-
In [the community repo](https://github.com/tektoncd/community) you'll
12-
find info on:
11+
In [the community repo](https://github.com/tektoncd/community) you'll find info
12+
on:
1313

1414
- [Contacting other contributors](https://github.com/tektoncd/community/blob/master/contact.md)
15-
- [Development standards](https://github.com/tektoncd/community/blob/master/standards.md) around
15+
- [Development standards](https://github.com/tektoncd/community/blob/master/standards.md)
16+
around
1617
[principles](https://github.com/tektoncd/community/blob/master/standards.md#principles),
1718
[commit messages](https://github.com/tektoncd/community/blob/master/standards.md#commit-messages)
18-
and [code](https://github.com/tektoncd/community/blob/master/standards.md#coding-standards)
19+
and
20+
[code](https://github.com/tektoncd/community/blob/master/standards.md#coding-standards)
1921
- [Processes](https://github.com/tektoncd/community/blob/master/process.md) like
2022
[finding something to work on](https://github.com/tektoncd/community/blob/master/process.md#finding-something-to-work-on),
2123
[proposing features](https://github.com/tektoncd/community/blob/master/process.md#proposing-features),
2224
[reviews](https://github.com/tektoncd/community/blob/master/process.md#reviews)
23-
and [becoming an OWNER](https://github.com/tektoncd/community/blob/master/process.md#owners)
25+
and
26+
[becoming an OWNER](https://github.com/tektoncd/community/blob/master/process.md#owners)
2427

2528
You can find details on our automation infrastructure in
2629
[the plumbing repo](https://github.com/tektoncd/plumbing).
@@ -38,7 +41,8 @@ You can see project details (including a burndown, issues in epics, etc.) on our
3841

3942
To see this board, you must:
4043

41-
- Ask [an OWNER](OWNERS) via [slack](https://github.com/tektoncd/community/blob/master/contact.md#slack)
44+
- Ask [an OWNER](OWNERS) via
45+
[slack](https://github.com/tektoncd/community/blob/master/contact.md#slack)
4246
for an invitation
4347
- Add [the ZenHub browser extension](https://www.zenhub.com/extension) to see
44-
new info via GitHub (or just use zenhub.com directly)
48+
new info via GitHub (or just use zenhub.com directly)

DEVELOPMENT.md

+24-12
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,33 @@ Then you can [iterate](#iterating) (including
1818

1919
### Ramp up
2020

21-
Welcome to the project!! You may find these resources helpful to ramp
22-
up on some of the technology this project is built on. This project
23-
extends Kubernetes (aka `k8s`) with Custom Resource Definitions (CRDSs). To
24-
find out more:
25-
26-
* [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" concretely mean
27-
* [Understanding Kubernetes objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) - This will further solidify k8s nomenclature
28-
* [API conventions - Types(kinds)](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds) - Another useful set of words describing words. "Objects" and "Lists" in k8s land
29-
* [Extend the Kubernetes API with CustomResourceDefinitions](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/)- A tutorial demonstrating how a Custom Resource Definition can be added to Kubernetes without anything actually "happening" beyond being able to list Objects of that kind
21+
Welcome to the project!! You may find these resources helpful to ramp up on some
22+
of the technology this project is built on. This project extends Kubernetes (aka
23+
`k8s`) with Custom Resource Definitions (CRDSs). To find out more:
24+
25+
- [The Kubernetes docs on Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) -
26+
These will orient you on what words like "Resource" and "Controller"
27+
concretely mean
28+
- [Understanding Kubernetes objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) -
29+
This will further solidify k8s nomenclature
30+
- [API conventions - Types(kinds)](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds) -
31+
Another useful set of words describing words. "Objects" and "Lists" in k8s
32+
land
33+
- [Extend the Kubernetes API with CustomResourceDefinitions](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/)-
34+
A tutorial demonstrating how a Custom Resource Definition can be added to
35+
Kubernetes without anything actually "happening" beyond being able to list
36+
Objects of that kind
3037

3138
At this point, you may find it useful to return to these `Tekton Pipeline` docs:
3239

33-
* [Tekton Pipeline README](https://github.com/tektoncd/pipeline/blob/master/docs/README.md) - Some of the terms here may make more sense!
34-
* Install via [official installation docs](https://github.com/tektoncd/pipeline/blob/master/docs/install.md) or continue though [getting started for development](#getting-started)
35-
* [Tekton Pipeline "Hello World" tutorial](https://github.com/tektoncd/pipeline/blob/master/docs/tutorial.md) - Define `Tasks`, `Pipelines`, and `PipelineResources`, see what happens when they are run
40+
- [Tekton Pipeline README](https://github.com/tektoncd/pipeline/blob/master/docs/README.md) -
41+
Some of the terms here may make more sense!
42+
- Install via
43+
[official installation docs](https://github.com/tektoncd/pipeline/blob/master/docs/install.md)
44+
or continue though [getting started for development](#getting-started)
45+
- [Tekton Pipeline "Hello World" tutorial](https://github.com/tektoncd/pipeline/blob/master/docs/tutorial.md) -
46+
Define `Tasks`, `Pipelines`, and `PipelineResources`, see what happens when
47+
they are run
3648

3749
### Checkout your fork
3850

code-of-conduct.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
7272
version 1.4, available at
7373
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7474

75-
[homepage]: https://www.contributor-covenant.org
75+
[homepage]: https://www.contributor-covenant.org

docs/tasks.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ following fields:
7474
by your `Task`
7575
- [`volumes`](#volumes) - Specifies one or more volumes that you want to make
7676
available to your `Task`'s steps.
77-
- [`containerTemplate`](#container-template) - Specifies a `Container`
77+
- [`containerTemplate`](#container-template) - Specifies a `Container`
7878
definition to use as the basis for all steps within your `Task`.
7979

8080
[kubernetes-overview]:
@@ -332,7 +332,7 @@ configuration that will be used as the basis for all [`steps`](#steps) in your
332332
`Task`. Configuration in an individual step will override or merge with the
333333
container template's configuration.
334334

335-
In the example below, the `Task` specifies a `containerTemplate` with the
335+
In the example below, the `Task` specifies a `containerTemplate` with the
336336
environment variable `FOO` set to `bar`. The first step will use that value for
337337
`FOO`, but in the second step, `FOO` is overridden and set to `baz`.
338338

@@ -344,12 +344,10 @@ containerTemplate:
344344
steps:
345345
- image: ubuntu
346346
command: [echo]
347-
args:
348-
["FOO is ${FOO}"]
347+
args: ["FOO is ${FOO}"]
349348
- image: ubuntu
350349
command: [echo]
351-
args:
352-
["FOO is ${FOO}"]
350+
args: ["FOO is ${FOO}"]
353351
env:
354352
- name: "FOO"
355353
value: "baz"

tekton/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,11 @@ good to go. Otherwise, you need to use
161161
[Members of the Tekton governing board](https://github.com/tektoncd/community/blob/master/governance.md)
162162
[have access to the underlying resources](https://github.com/tektoncd/community/blob/master/governance.md#permissions-and-access).
163163

164-
Users who need access to our production registry
165-
(`gcr.io/tekton-releases`) and production GCS bucket (`gs://tekton-releases`)
166-
should ping [a member of the governing board](https://github.com/tektoncd/community/blob/master/governance.md)
167-
to request access to [the production service account](#production-service-account).
164+
Users who need access to our production registry (`gcr.io/tekton-releases`) and
165+
production GCS bucket (`gs://tekton-releases`) should ping
166+
[a member of the governing board](https://github.com/tektoncd/community/blob/master/governance.md)
167+
to request access to
168+
[the production service account](#production-service-account).
168169

169170
##### Production service account
170171

0 commit comments

Comments
 (0)