Merge pull request #32 from fabriziopandini/initial-README

initial README

Author: k8s-ci-robot

README.md

@@ -1,29 +1,47 @@
-# Kubernetes Template Project
+# Cluster API bootstrap provider kubeadm
+## What is the Cluster API bootstrap provider kubeadm?
 
-The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files:
+Cluster API bootstrap provider is a component of
+[Cluster API](https://github.com/kubernetes-sigs/cluster-api/blob/master/README.md) 
+that is responsible of generating a cloud-init script to
+turn a Machine into a Kubernetes Node; this implementation uses [kubeadm](https://github.com/kubernetes/kubeadm) 
+for kubernetes bootstrap.
 
-- a `README.md` outlining the project goals, sponsoring sig, and community contact information
-- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners])
-- a `CONTRIBUTING.md` outlining how to contribute to the project
-- an unmodified copy of `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code
-- a `LICENSE` which must be Apache 2.0 for code projects, or [Creative Commons 4.0] for documentation repositories, without any custom content
-- a `SECURITY_CONTACTS` with the contact points for the Product Security Team
-  to reach out to for triaging and handling of incoming issues. They must agree to abide by the
-  [Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy)
-  and will be removed and replaced if they violate that agreement.
+### Resources
 
-## Community, discussion, contribution, and support
+* [design doc](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20190610-machine-states-preboot-bootstrapping.md)
+* [cluster-api.sigs.k8s.io](https://cluster-api.sigs.k8s.io)
+* [The Kubebuilder Book](https://book.kubebuilder.io)
 
-Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
+## Versioning, Maintenance, and Compatibility
 
-You can reach the maintainers of this project at:
+- We follow [Semantic Versioning (semver)](https://semver.org/).
+- Cluster API bootstrap provider kubeadm versioning is syncronized with
+  [Cluster API](https://github.com/kubernetes-sigs/cluster-api/blob/master/README.md).
+- The _master_ branch is where development happens, this might include breaking changes.
+- The _release-X_ branches contain stable, backward compatible code. A new _release-X_ branch
+  is created at every major (X) release.
 
-- [Slack](http://slack.k8s.io/)
-- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-dev)
+## Get involved!
 
-### Code of conduct
+* Join the [Cluster API discuss forum](https://discuss.kubernetes.io/c/contributors/cluster-api).
 
-Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
+* Join the [sig-cluster-lifecycle](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle)
+Google Group for access to documents and calendars.
 
-[owners]: https://git.k8s.io/community/contributors/guide/owners.md
-[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE
+* Join our Cluster API working group sessions
+  * Weekly on Wednesdays @ 10:00 PT on [Zoom][zoomMeeting]
+  * Previous meetings: \[ [notes][notes] | [recordings][recordings] \]
+
+* Provider implementer office hours
+  * Weekly on Tuesdays @ 12:00 PT ([Zoom][providerZoomMeetingTues]) and Wednesdays @ 15:00 CET ([Zoom][providerZoomMeetingWed])
+  * Previous meetings: \[ [notes][implementerNotes] \]
+
+* Chat with us on [Slack](http://slack.k8s.io/): #cluster-api
+
+[notes]: https://docs.google.com/document/d/1Ys-DOR5UsgbMEeciuG0HOgDQc8kZsaWIWJeKJ1-UfbY/edit
+[recordings]: https://www.youtube.com/playlist?list=PL69nYSiGNLP29D0nYgAGWt1ZFqS9Z7lw4
+[zoomMeeting]: https://zoom.us/j/861487554
+[implementerNotes]: https://docs.google.com/document/d/1IZ2-AZhe4r3CYiJuttyciS7bGZTTx4iMppcA8_Pr3xE/edit
+[providerZoomMeetingTues]: https://zoom.us/j/140808484
+[providerZoomMeetingWed]: https://zoom.us/j/424743530