Skip to content

Commit

Permalink
Format markdown
Browse files Browse the repository at this point in the history
Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
  • Loading branch information
mattmoor-sockpuppet authored and tekton-robot committed Apr 29, 2019
1 parent a572137 commit 530de18
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 30 deletions.
18 changes: 11 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,22 @@ our project and we hope you'll enjoy it :D

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

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

- [Contacting other contributors](https://github.com/tektoncd/community/blob/master/contact.md)
- [Development standards](https://github.com/tektoncd/community/blob/master/standards.md) around
- [Development standards](https://github.com/tektoncd/community/blob/master/standards.md)
around
[principles](https://github.com/tektoncd/community/blob/master/standards.md#principles),
[commit messages](https://github.com/tektoncd/community/blob/master/standards.md#commit-messages)
and [code](https://github.com/tektoncd/community/blob/master/standards.md#coding-standards)
and
[code](https://github.com/tektoncd/community/blob/master/standards.md#coding-standards)
- [Processes](https://github.com/tektoncd/community/blob/master/process.md) like
[finding something to work on](https://github.com/tektoncd/community/blob/master/process.md#finding-something-to-work-on),
[proposing features](https://github.com/tektoncd/community/blob/master/process.md#proposing-features),
[reviews](https://github.com/tektoncd/community/blob/master/process.md#reviews)
and [becoming an OWNER](https://github.com/tektoncd/community/blob/master/process.md#owners)
and
[becoming an OWNER](https://github.com/tektoncd/community/blob/master/process.md#owners)

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

To see this board, you must:

- Ask [an OWNER](OWNERS) via [slack](https://github.com/tektoncd/community/blob/master/contact.md#slack)
- Ask [an OWNER](OWNERS) via
[slack](https://github.com/tektoncd/community/blob/master/contact.md#slack)
for an invitation
- Add [the ZenHub browser extension](https://www.zenhub.com/extension) to see
new info via GitHub (or just use zenhub.com directly)
new info via GitHub (or just use zenhub.com directly)
36 changes: 24 additions & 12 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,33 @@ Then you can [iterate](#iterating) (including

### Ramp up

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:

* [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
* [Understanding Kubernetes objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) - This will further solidify k8s nomenclature
* [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
* [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
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:

- [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
- [Understanding Kubernetes objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) -
This will further solidify k8s nomenclature
- [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
- [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

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

* [Tekton Pipeline README](https://github.com/tektoncd/pipeline/blob/master/docs/README.md) - Some of the terms here may make more sense!
* Install via [official installation docs](https://github.com/tektoncd/pipeline/blob/master/docs/install.md) or continue though [getting started for development](#getting-started)
* [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
- [Tekton Pipeline README](https://github.com/tektoncd/pipeline/blob/master/docs/README.md) -
Some of the terms here may make more sense!
- Install via
[official installation docs](https://github.com/tektoncd/pipeline/blob/master/docs/install.md)
or continue though [getting started for development](#getting-started)
- [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

### Checkout your fork

Expand Down
2 changes: 1 addition & 1 deletion code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
[homepage]: https://www.contributor-covenant.org
10 changes: 4 additions & 6 deletions docs/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ following fields:
by your `Task`
- [`volumes`](#volumes) - Specifies one or more volumes that you want to make
available to your `Task`'s steps.
- [`containerTemplate`](#container-template) - Specifies a `Container`
- [`containerTemplate`](#container-template) - Specifies a `Container`
definition to use as the basis for all steps within your `Task`.

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

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

Expand All @@ -344,12 +344,10 @@ containerTemplate:
steps:
- image: ubuntu
command: [echo]
args:
["FOO is ${FOO}"]
args: ["FOO is ${FOO}"]
- image: ubuntu
command: [echo]
args:
["FOO is ${FOO}"]
args: ["FOO is ${FOO}"]
env:
- name: "FOO"
value: "baz"
Expand Down
9 changes: 5 additions & 4 deletions tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,11 @@ good to go. Otherwise, you need to use
[Members of the Tekton governing board](https://github.com/tektoncd/community/blob/master/governance.md)
[have access to the underlying resources](https://github.com/tektoncd/community/blob/master/governance.md#permissions-and-access).
Users who need access to our production registry
(`gcr.io/tekton-releases`) and production GCS bucket (`gs://tekton-releases`)
should ping [a member of the governing board](https://github.com/tektoncd/community/blob/master/governance.md)
to request access to [the production service account](#production-service-account).
Users who need access to our production registry (`gcr.io/tekton-releases`) and
production GCS bucket (`gs://tekton-releases`) should ping
[a member of the governing board](https://github.com/tektoncd/community/blob/master/governance.md)
to request access to
[the production service account](#production-service-account).
##### Production service account
Expand Down

0 comments on commit 530de18

Please sign in to comment.