Skip to content

Commit

Permalink
Add docs to help ppl new to the project ramp up on the context 🏫
Browse files Browse the repository at this point in the history
These docs and links come from @sbwsg! As he was ramping up he put
together this great list of resources (and the description wording is
mostly his too).

I hope we can continue to add to this ramp up section, definitely want
to make it as easy as possible for ppl to ramp up on the project, even
if they have no prior experience with k8s (let alone CRDs!).

Thanks @sbwsg :D <3
  • Loading branch information
bobcatfish authored and tekton-robot committed Apr 25, 2019
1 parent 11e03b7 commit cd7b993
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Getting started

1. [Ramp up on kubernetes and CRDs](#ramp-up)
1. Create [a GitHub account](https://github.com/join)
1. Setup
[GitHub access via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
Expand All @@ -15,6 +16,24 @@
Then you can [iterate](#iterating) (including
[runing the controllers with `ko`](#install-pipeline)).

### 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

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

### Checkout your fork

The Go tools require that you clone the repository to the
Expand Down

0 comments on commit cd7b993

Please sign in to comment.