Add new-contributors.md #226
Conversation
docs/new-contributors.md
Outdated
| But let's start with how they relate to each other. | ||
|
|
||
| * **Kubernetes** is the upstream container orchestration engine, to run containers on a cluster | ||
| * **OpenShift** **Origin** is a friendly fork of Kubernetes with additional features, and configured to meet more enterprise requirements (i.e. RBAC authentication) than stock Kubernetes |
There was a problem hiding this comment.
AFAIK, nothing in kubevirt relies on openshift specific features, so i'd rather not mention openshift at all - it'll just serve to confuse IMHO.
There was a problem hiding this comment.
Hm, makes sense. Especially if I consider i.e. tectonic, which is yet another K8s distrobution, then there is no particular reason why it must be mentioned here.
Removing it.
docs/new-contributors.md
Outdated
| @@ -0,0 +1,46 @@ | |||
| # Introduction | |||
|
|
|||
| Let's start with the realtionship between the two important components: | |||
There was a problem hiding this comment.
s/realtionship/relationship
docs/new-contributors.md
Outdated
|
|
||
| Let's start with the realtionship between the two important components: | ||
|
|
||
| * **Kubernetes** is the upstream container orchestration engine, to run containers on a cluster |
There was a problem hiding this comment.
... engine that runs containers in a cluster?
There was a problem hiding this comment.
A bit cumbersome, rephrasing
docs/new-contributors.md
Outdated
|
|
||
| Even that KubeVirt is an add-on to Kubernetes, both of them have things in common: | ||
|
|
||
| * Mostly written in Go Lang |
docs/new-contributors.md
Outdated
|
|
||
| ## Topics | ||
|
|
||
| ### Go Lang |
|
Thanks updated |
docs/new-contributors.md
Outdated
| * **Kubernetes** is a container orchestration system, and is used to run containers on a cluster | ||
| * **KubeVirt** is an add-on which is installed on-top of Kubernetes, to be able to add basic virtualization functionality to Kubernetes. | ||
|
|
||
| Even that KubeVirt is an add-on to Kubernetes, both of them have things in common: |
There was a problem hiding this comment.
Trivial typo s/that/though/
docs/new-contributors.md
Outdated
| Let's start with the relationship between the two important components: | ||
|
|
||
| * **Kubernetes** is a container orchestration system, and is used to run containers on a cluster | ||
| * **KubeVirt** is an add-on which is installed on-top of Kubernetes, to be able to add basic virtualization functionality to Kubernetes. |
There was a problem hiding this comment.
Where reasonable, try to keep line length below 80 chars. A few more cases below, but don't artificially break hyperlinks in the middle
There was a problem hiding this comment.
Yeah, that's tricky if the links get to long.
For now I shortened the lines, but even if the link exceeded the 80char limit, then I left it as it.
docs/new-contributors.md
Outdated
| Patterns | ||
|
|
||
| * [Introducing Operators: Putting Operational Knowledge into Software](https://coreos.com/blog/introducing-operators.html "https://coreos.com/blog/introducing-operators.html") | ||
| * [Microservices](https://martinfowler.com/articles/microservices.html "https://martinfowler.com/articles/microservices.html") nice content by Martin Fowler |
There was a problem hiding this comment.
Formatting in this block looks kind of odd. 'Getting started' is in a list bullet, but 'Patterns' is not ?!?
docs/new-contributors.md
Outdated
|
|
||
| Let's start with the relationship between the two important components: | ||
|
|
||
| * **Kubernetes** is a container orchestration system, and is used to run containers on a cluster |
There was a problem hiding this comment.
Nit-pick - only need a single whitespace after the list bullet - repeated elsewhere in the file
|
Updated. |
fabiand
force-pushed
the
new-contributors
branch
2 times, most recently
from
ee9f3aa
to
ab73678
Compare
|
Sigh - Now even with fixed indentation. |
Small document to provide some introductionlinks to related projects.