summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Farina <matt@mattfarina.com>2016-05-11 12:08:40 -0400
committerMatt Farina <matt@mattfarina.com>2016-05-11 12:08:40 -0400
commitb8071bb53236fb1c6361468ce0be6f089679f472 (patch)
tree0951a26cecfb7425522bcdd7687aae6fd3cc767e
parentbfbbc25a9ee1748dee1784b5c99403642bacce5f (diff)
Added base structure with example
* Add contribution guidelines * Updates readme with slack and SIG list * Migrates available SIG missions * Adds community meeting as basic example
-rw-r--r--CONTRIBUTING.md16
-rw-r--r--README.md91
-rw-r--r--community/README.md7
3 files changed, 113 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..00591970
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# Contributing guidelines
+
+This project is for documentation about the community. To contribute to one of
+the Kubernetes projects please see the contribution guide for that project.
+
+## How To Contribute
+
+The contributions here follow a [pull request](https://help.github.com/articles/using-pull-requests/) model with some additional process.
+The process is as follows:
+
+1. Submit a pull request with the requested change.
+2. Another person, other than a Special Interest Group (SIG) owner, can mark it Looks Good To Me (LGTM) upon successful review. Otherwise feedback can be given.
+3. A SIG owner can merge someone else's change into their SIG documentation immediate.
+4. Someone cannot immediately merge their own change. To merge your own change wait 24 hours during the week or 72 hours over a weekend. This allows others the opportunity to review a change.
+
+_Note, the SIG Owners decide on the layout for their own sub-directory structure._
diff --git a/README.md b/README.md
index 1f83c659..47e2d8aa 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,90 @@
-# community \ No newline at end of file
+# Kubernetes Community Documentation
+
+Welcome to the Kubernetes community documentation. Here you can learn about what's happening in the community.
+
+## Slack Chat
+
+Kubernetes uses [Slack](http://slack.com) for community discussions.
+
+**Join**: Joining is self service. Go to [slack.k8s.io](http://slack.k8s.io) to join.
+
+**Access**: Once you join, the team can be found at [kubernetes.slack.io](http://kubernetes.slack.io)
+
+**Archives**: Discussions on most channels are archived at [kubernetes.slackarchive.io](http://kubernetes.slackarchive.io). Start archiving by inviting the slackarchive bot to a channel via `/invite @slackarchive`
+
+To add new channels, contact one of the admins. Currently that includes briangrant, goltermann, jbeda, and thockin.
+
+## Special Interest Groups (SIG)
+
+Much of the community activity is organized into a community meeting and numerous SIGs. Each of those groups operates a little differently which is reflected in how they capture notes, examples, and other information. Each groups material is in its subdirectory in this project.
+
+The current SIGs are:
+
+### [Weekly Community Video Conference](community/README.md)
+
+The weekly community meeting provides an opportunity for the different SIGs and other parts of the community to come together.
+
+### SIG API Machinery
+
+The [Mission Doc](https://goo.gl/x5nWrF)
+
+### SIG Auth
+
+Kubernetes Special Interest Group for Authentication and Authorization.
+
+Goals for this SIG is to discuss improvements Kubernetes Authorization and Authentication, and cluster security policy. Not in scope for this SIG is to report specific vulnerabilities in Kubernetes, please report using these instructions: http://kubernetes.io/v1.1/docs/reporting-security-issues.html
+
+### SIG Autoscaling
+
+The scope of our SIG includes (but is not limited to):
+
+* autoscaling of clusters,
+* horizontal and vertical autoscaling of pods,
+* setting initial resources for pods,
+* topics related to monitoring pods and gathering their metrics (e.g.: Heapster)
+
+### SIG Cluster Ops
+
+SIG Cluster Ops Mission is to promote operability and interoperability of Kubernetes clusters. We focus on shared operations practices for Kubernetes clusters with a goal to make kubernetes broadly accessible with a common baseline reference. We also organize operators as a sounding board and advocacy group.
+
+### SIG Federation
+
+This is a SIG focused on Federation of Kubernetes Clusters ("Ubernetes") and related topics. This includes:
+
+* Application resiliency against availability zone outages
+* Hybrid clouds
+* Spanning of multiple could providers
+* Application migration from private to public clouds (and vice versa)
+* ... and other similar subjects.
+
+### SIG Network
+
+This SIG is to promote and discuss network issues and operations.
+
+### SIG Node
+
+Mission Statement?
+
+### SIG OpenStack
+
+Mission Statement?
+
+### SIG Scalability
+
+Mission Statement?
+
+### SIG Scheduling
+
+Mission Statement?
+
+### SIG Storage
+
+The Kubernetes Storage Special-Interest-Group (SIG) is a working group within the Kubernetes contributor community interested in storage and volume plugins.
+
+### SIG Testing
+
+Mission Statement?
+
+### SIG UI
+
+Mission Statement?
diff --git a/community/README.md b/community/README.md
new file mode 100644
index 00000000..5c5c3b42
--- /dev/null
+++ b/community/README.md
@@ -0,0 +1,7 @@
+# Weekly Community Video Conference
+
+We have PUBLIC and RECORDED weekly video meetings every Thursday at 10am US Pacific Time. You can [find the time in your timezone with this table](http://time.is/compare/1000AM_in_PT).
+
+To be added to the calendar items, join this [google group](https://groups.google.com/forum/#!forum/kubernetes-community-video-chat) for further instructions.
+
+If you have a topic you'd like to present or would like to see discussed, please propose a specific date on the Kubernetes Community Meeting [Working Document](https://docs.google.com/document/d/1VQDIAB0OqiSjIHI8AWMvSdceWhnz56jNpZrLs6o7NJY/edit#).