diff options
| -rw-r--r-- | CLA.md | 68 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 36 | ||||
| -rw-r--r-- | README.md | 113 | ||||
| -rw-r--r-- | communication.md | 97 | ||||
| -rw-r--r-- | community/README.md | 7 | ||||
| -rw-r--r-- | contributors/devel/pull-requests.md | 10 | ||||
| -rw-r--r-- | sig-cli/contributing.md | 12 | ||||
| -rw-r--r-- | sig-list.md | 43 |
8 files changed, 291 insertions, 95 deletions
@@ -1,30 +1,70 @@ -### How do I sign the CNCF CLA? +# The Contributor License Agreement -* To sign up as an individual or as an employee of a signed organization, go to https://identity.linuxfoundation.org/projects/cncf -* To sign up as an organization, go to https://identity.linuxfoundation.org/node/285/organization-signup -* To review the CNCF CLA, go to https://github.com/cncf/cla +The [Cloud Native Computing Foundation][CNCF] defines the legal status of the +contributed code in a _Contributor License Agreement_ (CLA). -*** +Only original source code from CLA signatories can be accepted into kubernetes. -### After you select one of the options above, please follow the instructions below: +This policy does not apply to [third_party] and [vendor]. -**Step 1**: You must sign in with GitHub. +## How do I sign? -**Step 2**: If you are signing up as an employee, you must use your official person@organization.domain email address in the CNCF account registration page. +#### 1. Read + * [CLA for individuals] to sign up as an individual or as an employee of a signed organization. + * [CLA for corporations] to sign as a corporation representative and manage signups from your organization. + +#### 2. Sign in with GitHub. -**Step 3**: The email you use on your commits (https://help.github.com/articles/setting-your-email-in-git/) must match the email address you use when signing up for the CNCF account. +Click + * [Individual signup] to sign up as an individual or as an employee of a signed organization. + * [Corp signup] to sign as a corporation representative and manage signups from your organization. + +Either signup form looks like this: + + + +#### 3. Enter the correct E-mail address to validate! + +The address entered on the form must meet two constraints: + + * It __must match__ your [git email] (the output of `git config user.email`) + or your PRs will not be approved! + + * It must be your official `person@organization.com` address if you signed up + as an employee of said organization. -  +#### 4. Look for an email indicating successful signup. + +> The Linux Foundation +> +> Hello, +> +> You have signed CNCF Individual Contributor License Agreement. +> You can see your document anytime by clicking View on HelloSign. +> -**Step 4**: Once the CLA sent to your email address is signed (or your email address is verified in case your organization has signed the CLA), you should be able to check that you are authorized in any new PR you create. +Once you have this, the CLA authorizer bot will authorize your PRs.  -**Step 5**: The status on your old PRs will be updated when any new comment is made on it. -### I'm having issues with signing the CLA. +## Troubleshooting + +If you have signup trouble, please explain your case on +the [CLA signing issue] and we (@sarahnovotny and @foxish), +along with the [CNCF] will help sort it out. + +Another option: ask for help at `helpdesk@rt.linuxfoundation.org`. -If you're facing difficulty with signing the CNCF CLA, please explain your case on https://github.com/kubernetes/kubernetes/issues/27796 and we (@sarahnovotny and @foxish), along with the CNCF will help sort it out. +[CNCF]: https://www.cncf.io/community +[CLA signing issue]: https://github.com/kubernetes/kubernetes/issues/27796 +[CLA for individuals]: https://github.com/cncf/cla/blob/master/individual-cla.pdf +[CLA for corporations]: https://github.com/cncf/cla/blob/master/corporate-cla.pdf +[Corp signup]: https://identity.linuxfoundation.org/node/285/organization-signup +[Individual signup]: https://identity.linuxfoundation.org/projects/cncf +[git email]: https://help.github.com/articles/setting-your-email-in-git +[third_party]: https://github.com/kubernetes/kubernetes/tree/master/third_party +[vendor]: https://github.com/kubernetes/kubernetes/tree/master/vendor
\ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00591970..8dc16c3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,30 @@ -# Contributing guidelines +# Contributing to the community repo -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 +Contributions to this community repository follow a +[pull request](https://help.github.com/articles/using-pull-requests/) (PR) +model: -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 PR with your change -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. +#### 2. Get an LGTM. -_Note, the SIG Owners decide on the layout for their own sub-directory structure._ +Upon successful review, someone will give the PR +a __LGTM__ (_looks good to me_) in the review thread. + +#### 3. Allow time for others to see it + +Once you have an __LGTM__, please wait 24 hours during +the week or 72 hours over a weekend before you +merge it, to give others (besides your initial reviewer) +time to see it. + +__That said, a [SIG lead](sig-list.md) may shortcut this by merging +someone else's change into their SIG's documentation +at any time.__ + +Edits in SIG sub-directories should follow structure and guidelines set +by the respective SIG leads - see `CONTRIBUTING` instructions in subdirectories. + + +
\ No newline at end of file @@ -1,71 +1,86 @@ -# Kubernetes Community Documentation +# Kubernetes Community -Welcome to the Kubernetes community documentation. Here you can learn about what's happening in the community. +Welcome to the Kubernetes community! -## Slack Chat +This is the starting point for becoming a contributor - improving docs, improving code, giving talks etc. +## Communicating -Kubernetes uses [Slack](http://slack.com) for community discussions. +General communication channels - e.g. filing issues, chat, mailing lists and +conferences are listed on the [communication](communication.md) page. -**Join**: Joining is self-service. Go to [slack.k8s.io](http://slack.k8s.io) to join. +For more specific topics, try a SIG. -**Access**: Once you join, the team can be found at [kubernetes.slack.com](http://kubernetes.slack.com) +## SIGs -**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` +Kubernetes is a set of projects, each shepherded by a special interest group (SIG). + +A first step to contributing is to pick from the [list of kubernetes SIGs](sig-list.md). -To add new channels, contact one of the admins. Currently that includes briangrant, goltermann, jbeda, sarahnovotny and thockin. +A SIG can have its own policy for contribution, +described in a `README` or `CONTRIBUTING` file in the SIG +folder in this repo (e.g. [sig-cli/contributing](sig-cli/contributing.md)), +and its own mailing list, slack channel, etc. + +## How Can I help? -## kubernetes mailing lists +Documentation (like the text you are reading now) can +always use improvement! -Many important announcements and discussions end up on the main development group. +There's a [semi-curated list of issues][help-wanted] +that should not need deep knowledge of the system. -kubernetes-dev@googlegroups.com +To dig deeper, read a design doc, e.g. [architecture]. -[Google Group](https://groups.google.com/forum/#!forum/kubernetes-dev) +[Pick a SIG](sig-list.md), peruse its associated [cmd] directory, +find a `main()` and read code until you find something you want to fix. -Users of kubernetes trade notes on: +There's always code that can be clarified and variables +or functions that can be renamed or commented. -kubernetes-users@googlegroups.com +There's always a need for more test coverage. -[Google Group](https://groups.google.com/forum/#!forum/kubernetes-users) +## Learn to Build +Links in [contributors/devel/README.md](contributors/devel/README.md) +lead to many relevant topics, including + * [Developer's Guide] - how to start a build/test cycle + * [Collaboration Guide] - how to work together + * [expectations] - what the community expects + * [pull request] policy - how to prepare a pull request -## [Weekly Community Video Conference](community/README.md) +## Making a Pull Request -The [weekly community meeting](https://zoom.us/my/kubernetescommunity) provides an opportunity for the different SIGs, WGs and other parts of the community to come together. More information about joining the weekly community meeting is available on our [agenda working document] (https://docs.google.com/document/d/1VQDIAB0OqiSjIHI8AWMvSdceWhnz56jNpZrLs6o7NJY/edit#) +We recommend that you work on existing issues before attempting +to [develop a new feature]. -## Special Interest Groups (SIG) and Working Groups +Find an existing issue (e.g. one marked [help-wanted], or simply +ask a SIG lead for suggestions), and respond on the issue thread +expressing interest in working on it. + +This helps other people know that the issue is active, and +hopefully prevents duplicated efforts. -Much of the community activity is organized into a community meeting, numerous SIGs and time bounded WGs. SIGs follow these [guidelines](governance.md) although each of these groups may operate a little differently depending on their needs and workflow. Each groups material is in its subdirectory in this project. +Before submitting a pull request, sign the [CLA]. -The community meeting calendar is available as an [iCal to subscribe to] (https://calendar.google.com/calendar/ical/cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com/public/basic.ics) (simply copy and paste the url into any calendar product that supports the iCal format) or [html to view] (https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles). +If you want to work on a new idea of relatively small scope: -| Name | Leads | Group | Slack Channel | Meetings | -|------|-------|-------|---------------|----------| -| [API Machinery](sig-api-machinery/README.md) | [@lavalamp (Daniel Smith, Google)](https://github.com/lavalamp) <br> [@deads2k (David Eads, Red Hat)] (https://github.com/orgs/kubernetes/people/deads2k)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-api-machinery) | [#sig-api-machinery](https://kubernetes.slack.com/messages/sig-api-machinery/) | [Every other Wednesday at 11:00 AM PST](https://staging.talkgadget.google.com/hangouts/_/google.com/kubernetes-sig) | -| [Apps](sig-apps/README.md) | [@michelleN (Michelle Noorali, Deis)](https://github.com/michelleN)<br>[@mattfarina (Matt Farina, HPE)](https://github.com/mattfarina) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-apps) | [#sig-apps](https://kubernetes.slack.com/messages/sig-apps) | [Mondays 9:00AM PST](https://zoom.us/j/4526666954) | -| [Auth](sig-auth/README.md) | [@ erictune (Eric Tune, Google)](https://github.com/erictune)<br> [@ericchiang (Eric Chiang, CoreOS)](https://github.com/orgs/kubernetes/people/ericchiang)<br> [@liggitt (Jordan Liggitt, Red Hat)] (https://github.com/orgs/kubernetes/people/liggitt) <br> [@deads2k (David Eads, Red Hat)] (https://github.com/orgs/kubernetes/people/deads2k) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-auth) | [#sig-auth](https://kubernetes.slack.com/messages/sig-auth/) | Biweekly [Wednesdays at 1100 to 1200 PT](https://zoom.us/my/k8s.sig.auth) | -| [Autoscaling](sig-autoscaling/README.md) | [@fgrzadkowski (Filip Grządkowski, Google)](https://github.com/fgrzadkowski)<br> [@directxman12 (Solly Ross, Red Hat)](https://github.com/directxman12) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-autoscaling) | [#sig-autoscaling](https://kubernetes.slack.com/messages/sig-autoscaling/) | Biweekly (or triweekly) on [Thurs at 0830 PT](https://plus.google.com/hangouts/_/google.com/k8s-autoscaling) | -| [AWS](sig-aws/README.md) | [@justinsb (Justin Santa Barbara)](https://github.com/justinsb)<br>[@kris-nova (Kris Nova)](https://github.com/kris-nova)<br>[@chrislovecnm (Chris Love)](https://github.com/chrislovecnm)<br>[@mfburnett (Mackenzie Burnett)](https://github.com/mfburnett) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-aws) | [#sig-aws](https://kubernetes.slack.com/messages/sig-aws/) | We meet on [Zoom](https://zoom.us/my/k8ssigaws), and the calls are scheduled via the official [group mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-aws) | -| [Big Data](sig-big-data/README.md) | [@foxish (Anirudh Ramanathan, Google)](https://github.com/foxish)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-big-data) | [#sig-big-data](https://kubernetes.slack.com/messages/sig-big-data/) | Wednesdays at 10am PST, link posted in [the official group](https://groups.google.com/forum/#!forum/kubernetes-sig-big-data). | -| [CLI](sig-cli/README.md) | [@fabianofranz (Fabiano Franz, Red Hat)](https://github.com/fabianofranz)<br>[@pwittrock (Phillip Wittrock, Google)](https://github.com/pwittrock)<br>[@AdoHe (Tony Ado, Alibaba)](https://github.com/AdoHe) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-cli) | [#sig-cli](https://kubernetes.slack.com/messages/sig-cli) | Bi-weekly Wednesdays at 9:00 AM PT on [Zoom](https://zoom.us/my/sigcli) | -| [Cluster Lifecycle](sig-cluster-lifecycle/README.md) | [@lukemarsden (Luke Marsden, Weave)] (https://github.com/lukemarsden) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle) | [#sig-cluster-lifecycle](https://kubernetes.slack.com/messages/sig-cluster-lifecycle) | Tuesdays at 09:00 AM PST on [Zoom](https://zoom.us/j/166836624) | -| [Cluster Ops](sig-cluster-ops/README.md) | [@zehicle (Rob Hirschfeld, RackN)](https://github.com/zehicle) <br> [@mikedanese (Mike Danese, Google] (https://github.com/mikedanese) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-ops) | [#sig-cluster-ops](https://kubernetes.slack.com/messages/sig-cluster-ops) | Thursdays at 1:00 PM PST on [hangouts](https://plus.google.com/hangouts/_/google.com/sig-cluster-ops)| -| [Contributor Experience](sig-contribx/README.md) | [@grodrigues3 (Garrett Rodrigues, Google)](https://github.com/Grodrigues3) <br> [@pwittrock (Phillip Witrock, Google)] (https://github.com/pwittrock) <br> [@Phillels (Elsie Phillips, CoreOS)](https://github.com/Phillels) | [Group](https://groups.google.com/forum/#!forum/kubernetes-wg-contribex) | [#wg-contribex] (https://kubernetes.slack.com/messages/wg-contribex) | Biweekly Wednesdays 9:30 AM PST on [zoom] (https://zoom.us/j/4730809290) | -| [Docs] (sig-docs/README.md) | [@pwittrock (Philip Wittrock, Google)] (https://github.com/pwittrock) <br> [@devin-donnelly (Devin Donnelly, Google)] (https://github.com/devin-donnelly) <br> [@jaredbhatti (Jared Bhatti, Google)] (https://github.com/jaredbhatti)| [Group] (https://groups.google.com/forum/#!forum/kubernetes-sig-docs) | [#sig-docs] (https://kubernetes.slack.com/messages/sig-docs) | Tuesdays @ 10:30AM PST on [Zoom](https://zoom.us/j/678394311) | -| [Federation](sig-federation/README.md) | [@csbell (Christian Bell, Google)](https://github.com/csbell) <br> [@quinton-hoole (Quinton Hoole, Huawei)](https://github.com/quinton-hoole) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-federation) | [#sig-federation](https://kubernetes.slack.com/messages/sig-federation/) | Bi-weekly on Monday at 9:00 AM PST on [hangouts](https://plus.google.com/hangouts/_/google.com/ubernetes) | -| [Instrumentation](sig-instrumentation/README.md) | [@piosz (Piotr Szczesniak, Google)](https://github.com/piosz) <br> [@fabxc (Fabian Reinartz, CoreOS)](https://github.com/fabxc) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-instrumentation) | [#sig-instrumentation](https://kubernetes.slack.com/messages/sig-instrumentation) | [Thursdays at 9.30 AM PST](https://zoom.us/j/5342565819) | -| [Network](sig-network/README.md) | [@thockin (Tim Hockin, Google)](https://github.com/thockin)<br> [@dcbw (Dan Williams, Red Hat)](https://github.com/dcbw)<br> [@caseydavenport (Casey Davenport, Tigera)](https://github.com/caseydavenport) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-network) | [#sig-network](https://kubernetes.slack.com/messages/sig-network/) | Thursdays at 2:00 PM PST on [Zoom](https://zoom.us/j/5806599998) | -| [Node](sig-node/README.md) | [@dchen1107 (Dawn Chen, Google)](https://github.com/dchen1107)<br>[@euank (Euan Kemp, CoreOS)](https://github.com/orgs/kubernetes/people/euank)<br>[@derekwaynecarr (Derek Carr, Red Hat)](https://github.com/derekwaynecarr) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-node) | [#sig-node](https://kubernetes.slack.com/messages/sig-node/) | [Tuesdays at 10:00 PT](https://plus.google.com/hangouts/_/google.com/sig-node-meetup?authuser=0) | -| [On Prem](sig-on-prem/README.md) | [@josephjacks (Joseph Jacks, Apprenda)] (https://github.com/josephjacks) <br> [@zen (Tomasz Napierala, Mirantis)] (https://github.com/zen)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-on-prem) | [#sig-onprem](https://kubernetes.slack.com/messages/sig-onprem/) | Every two weeks on Wednesday at 9 PM PST / 12 PM EST | -| [OpenStack](sig-openstack/README.md) | [@idvoretskyi (Ihor Dvoretskyi, Mirantis)] (https://github.com/idvoretskyi) <br> [@xsgordon (Steve Gordon, Red Hat)] (https://github.com/xsgordon)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-openstack) | [#sig-openstack](https://kubernetes.slack.com/messages/sig-openstack/) | Every second Wednesday at 5 PM PDT / 2 PM EDT | -| [PM](sig-pm/README.md) | [@apsinha (Aparna Sinha, Google)](https://github.com/apsinha) <br> [@idvoretskyi (Ihor Dvoretskyi, Mirantis)](https://github.com/idvoretskyi) <br> [@calebamiles (Caleb Miles, CoreOS)](https://github.com/calebamiles)| [Group](https://groups.google.com/forum/#!forum/kubernetes-pm) | [#kubernetes-pm](https://kubernetes.slack.com/messages/kubernetes-pm/) | TBD| -| [Rktnetes](sig-rktnetes/README.md) | [@euank (Euan Kemp, CoreOS)] (https://github.com/euank) <br> [@tmrts (Tamer Tas)] (https://github.com/tmrts) <br> [@yifan-gu (Yifan Gu, CoreOS)] (https://github.com/yifan-gu) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-rktnetes) | [#sig-rktnetes](https://kubernetes.slack.com/messages/sig-rktnetes/) | [As needed (ad-hoc)](https://zoom.us/j/830298957) | -| [Scalability](sig-scalability/README.md) | [@lavalamp (Daniel Smith, Google)](https://github.com/lavalamp)<br>[@countspongebob (Bob Wise, Samsung SDS)](https://github.com/countspongebob)<br>[@jbeda (Joe Beda)](https://github.com/jbeda) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-scale) | [#sig-scale](https://kubernetes.slack.com/messages/sig-scale/) | [Thursdays at 09:00 PT](https://zoom.us/j/989573207) | -| [Scheduling](sig-scheduling/README.md) | [@davidopp (David Oppenheimer, Google)](https://github.com/davidopp)<br>[@timothysc (Timothy St. Clair, Red Hat)](https://github.com/timothysc) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-scheduling) | [#sig-scheduling](https://kubernetes.slack.com/messages/sig-scheduling/) | Alternate between Mondays at 1 PM PT and Wednesdays at 12:30 AM PT on [Zoom](https://zoom.us/zoomconference?m=rN2RrBUYxXgXY4EMiWWgQP6Vslgcsn86) | -| [Service Catalog](sig-service-catalog/README.md) | [@pmorie (Paul Morie, Red Hat)](https://github.com/pmorie) <br> [@arschles (Aaron Schlesinger, Deis)](github.com/arschles) <br> [@bmelville (Brendan Melville, Google)](https://github.com/bmelville) <br> [@duglin (Doug Davis, IBM)](https://github.com/duglin)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-service-catalog) | [#sig-service-catalog](https://kubernetes.slack.com/messages/sig-service-catalog/) | [Mondays at 1 PM PST](https://zoom.us/j/7201225346) | -| [Storage](sig-storage/README.md) | [@saad-ali (Saad Ali, Google)](https://github.com/saad-ali)<br>[@childsb (Brad Childs, Red Hat)](https://github.com/childsb) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-storage) | [#sig-storage](https://kubernetes.slack.com/messages/sig-storage/) | Bi-weekly Thursdays 9 AM PST (or more frequently) on [Zoom](https://zoom.us/j/614261834) | -| [Testing](sig-testing/README.md) | [@spiffxp (Aaron Crickenberger, Samsung)](https://github.com/spiffxp)<br>[@ixdy (Jeff Grafton, Google)](https://github.com/ixdy) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-testing) | [#sig-testing](https://kubernetes.slack.com/messages/sig-testing/) | [Tuesdays at 9:30 AM PT](https://zoom.us/j/553910341) | -| [UI](sig-ui/README.md) | [@romlein (Dan Romlein, Apprenda)](https://github.com/romlein)<br> [@bryk (Piotr Bryk, Google)](https://github.com/bryk) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-ui) | [#sig-ui](https://kubernetes.slack.com/messages/sig-ui/) | Wednesdays at 4:00 PM CEST | -| [Windows](sig-windows/README.md) | [@michmike77 (Michael Michael, Apprenda)](https://github.com/michmike)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-windows) | [#sig-windows](https://kubernetes.slack.com/messages/sig-windows) | Bi-weekly Tuesdays at 9:30 AM PT | + 1. Submit an issue describing your proposed change to the repo in question. + 1. The repo owners will respond to your issue promptly. + 1. If your proposed change is accepted, + sign the [CLA], + and start work in your fork. + 1. Submit a [pull request] containing a tested change. + + +[architecture]: https://github.com/kubernetes/kubernetes/blob/master/docs/design/architecture.md +[cmd]: https://github.com/kubernetes/kubernetes/tree/master/cmd +[CLA]: cla.md +[Collaboration Guide]: contributors/devel/development.md +[Developer's Guide]: contributors/devel/development.md +[develop a new feature]: https://github.com/kubernetes/features +[expectations]: contributors/devel/community-expectations.md +[help-wanted]: https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted +[pull request]: contributors/devel/pull-requests.md + +[]() -### [How to start a SIG](sig-creation-procedure.md) diff --git a/communication.md b/communication.md new file mode 100644 index 00000000..562fb788 --- /dev/null +++ b/communication.md @@ -0,0 +1,97 @@ +# Communication + +The Kubernetes community abides by the [CNCF code of conduct]. Here is an excerpt: + +> _As contributors and maintainers of this project, and in the interest +> of fostering an open and welcoming community, we pledge to respect +> all people who contribute through reporting issues, posting feature +> requests, updating documentation, submitting pull requests or patches, +> and other activities._ + +## SIGs + +Kubernetes encompasses many projects, organized into [SIGs](sig-list.md). +Some communication has moved into SIG-specific channels - see +a given SIG subdirectory for details. + +Nevertheless, below find a list of many general channels, groups +and meetings devoted to Kubernetes. + +## Social Media + +* [Twitter] +* [Google+] +* [blog] +* Pose questions and help answer them on [Slack][slack.k8s.io] or [Stack Overflow]. + +Most real time discussion happens at [kubernetes.slack.com]; +you can sign up at [slack.k8s.io]. + +Discussions on most channels are archived at [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 +(briangrant, goltermann, jbeda, sarahnovotny and thockin). + +## Issues + +If you have a question about Kubernetes or have a problem using it, +please start with the [troubleshooting guide]. + +If that doesn't answer your questions, or if you think you found a bug, +please [file an issue]. + + +## Mailing lists + +Development announcements and discussions appear on the Google group +[kubernetes-dev] (send mail to `kubernetes-dev@googlegroups.com`). + +Users trade notes on the Google group +[kubernetes-users] (send mail to `kubernetes-users@googlegroups.com`). + + +## Weekly Meeting + +We have PUBLIC and RECORDED [weekly meeting] every Thursday at 10am US Pacific Time. + +Map that to your local time with this [timezone table]. + +See it on the web at [calendar.google.com], or paste this [iCal url] into any iCal client. + +To be added to the calendar items, join the Google group +[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 Agenda]. + + +## Conferences + +* [kubecon] +* [cloudnativecon] + + +[blog]: http://blog.kubernetes.io +[calendar.google.com]: https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles +[cloudnativecon]: http://events.linuxfoundation.org/events/cloudnativecon +[CNCF code of conduct]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md +[communication]: https://github.com/kubernetes/community/blob/master/communication.md +[community meeting]: https://github.com/kubernetes/community/blob/master/communication.md#weekly-meeting +[file an issue]: https://github.com/kubernetes/kubernetes/issues/new +[Google+]: https://plus.google.com/u/0/b/116512812300813784482/116512812300813784482 +[iCal url]: https://calendar.google.com/calendar/ical/cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com/public/basic.ics +[kubecon]: http://events.linuxfoundation.org/events/kubecon +[Kubernetes Community Meeting Agenda]: https://docs.google.com/document/d/1VQDIAB0OqiSjIHI8AWMvSdceWhnz56jNpZrLs6o7NJY/edit# +[kubernetes-community-video-chat]: https://groups.google.com/forum/#!forum/kubernetes-community-video-chat +[kubernetes-dev]: https://groups.google.com/forum/#!forum/kubernetes-dev +[kubernetes-users]: https://groups.google.com/forum/#!forum/kubernetes-users +[kubernetes.slackarchive.io]: http://kubernetes.slackarchive.io +[kubernetes.slack.com]: http://kubernetes.slack.com +[Special Interest Group]: https://github.com/kubernetes/community/blob/master/README.md#SIGs +[slack.k8s.io]: http://slack.k8s.io +[Stack Overflow]: http://stackoverflow.com/questions/tagged/kubernetes +[timezone table]: https://www.google.com/search?q=1000+am+in+pst +[troubleshooting guide]: http://kubernetes.io/docs/troubleshooting +[Twitter]: https://twitter.com/kubernetesio +[weekly meeting]: https://zoom.us/my/kubernetescommunity diff --git a/community/README.md b/community/README.md deleted file mode 100644 index 359f3fcb..00000000 --- a/community/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Weekly Community Video Conference - -We have PUBLIC and RECORDED [weekly video meetings](https://zoom.us/my/kubernetescommunity) every Thursday at 10am US Pacific Time. You can [find the time in your timezone with this table](https://www.google.com/search?q=1000+am+in+pst). - -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#). diff --git a/contributors/devel/pull-requests.md b/contributors/devel/pull-requests.md index 1e75f3b1..dec5238f 100644 --- a/contributors/devel/pull-requests.md +++ b/contributors/devel/pull-requests.md @@ -13,9 +13,13 @@ # Pull Request Process -An overview of how pull requests are managed for kubernetes. This document -assumes the reader has already followed the [development guide](development.md) -to set up their environment. +An overview of how pull requests are managed for kubernetes. + +This document assumes the reader has already followed the +[development guide](development.md) to set up their environment, +and understands +[basic pull request mechanics](https://help.github.com/articles/using-pull-requests). + # Life of a Pull Request diff --git a/sig-cli/contributing.md b/sig-cli/contributing.md index 183e3e9e..80617e87 100644 --- a/sig-cli/contributing.md +++ b/sig-cli/contributing.md @@ -45,15 +45,7 @@ assigned a piece of work. Do this right away. ### Agree to contribution rules -The [Cloud Native Computing Foundation][CNCF] defines the legal status of the -contributed code in a _Contributor License Agreement_. - -Sign it electronically following these [instructions][CLA]. - -Sign using the same email identity that you plan to use -to push code via git (i.e., the output of `git config user.email`). - -If you have trouble, ask for help at `helpdesk@rt.linuxfoundation.org`. +Follow the [CLA signup instructions](../CLA.md). ### Adopt an issue @@ -284,8 +276,6 @@ See the sig-cli [community page] for points of contact and meeting times: - `@kubernetes/sig-cli-proposals` flags a design proposal. [@mentions]: https://help.github.com/articles/basic-writing-and-formatting-syntax/#mentioning-users-and-teams -[CLA]: https://github.com/kubernetes/kubernetes/wiki/CLA-FAQ -[CNCF]: https://www.cncf.io/community [Kubernetes Basics Tutorial]: https://kubernetes.io/docs/tutorials/kubernetes-basics [PR]: https://help.github.com/articles/creating-a-pull-request [`PTAL`]: https://en.wiktionary.org/wiki/PTAL diff --git a/sig-list.md b/sig-list.md new file mode 100644 index 00000000..fa9360ae --- /dev/null +++ b/sig-list.md @@ -0,0 +1,43 @@ +# SIGs and Working Groups + +Most community activity is organized into Special Interest Groups (SIGs), +time bounded Working Groups, and the [community meeting](communication.md#Meeting). + +SIGs follow these [guidelines](governance.md) although each of these groups may operate a little differently +depending on their needs and workflow. + +Each group's material is in its subdirectory in this project. + +When the need arises, a [new SIG can be created](sig-creation-procedure.md) + +### Master SIG List + +| Name | Leads | Group | Slack Channel | Meetings | +|------|-------|-------|---------------|----------| +| [API Machinery](sig-api-machinery/README.md) | [@lavalamp](https://github.com/lavalamp) Daniel Smith, Google <br> [@deads2k](https://github.com/orgs/kubernetes/people/deads2k) David Eads, Red Hat| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-api-machinery) | [#sig-api-machinery](https://kubernetes.slack.com/messages/sig-api-machinery/) | [Every other Wednesday at 11:00 AM PST](https://staging.talkgadget.google.com/hangouts/_/google.com/kubernetes-sig) | +| [Apps](sig-apps/README.md) | [@michelleN (Michelle Noorali, Deis)](https://github.com/michelleN)<br>[@mattfarina (Matt Farina, HPE)](https://github.com/mattfarina) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-apps) | [#sig-apps](https://kubernetes.slack.com/messages/sig-apps) | [Mondays 9:00AM PST](https://zoom.us/j/4526666954) | +| [Auth](sig-auth/README.md) | [@erictune (Eric Tune, Google)](https://github.com/erictune)<br> [@ericchiang (Eric Chiang, CoreOS)](https://github.com/orgs/kubernetes/people/ericchiang)<br> [@liggitt (Jordan Liggitt, Red Hat)](https://github.com/orgs/kubernetes/people/liggitt) <br> [@deads2k (David Eads, Red Hat)](https://github.com/orgs/kubernetes/people/deads2k) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-auth) | [#sig-auth](https://kubernetes.slack.com/messages/sig-auth/) | Biweekly [Wednesdays at 1100 to 1200 PT](https://zoom.us/my/k8s.sig.auth) | +| [Autoscaling](sig-autoscaling/README.md) | [@fgrzadkowski (Filip Grządkowski, Google)](https://github.com/fgrzadkowski)<br> [@directxman12 (Solly Ross, Red Hat)](https://github.com/directxman12) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-autoscaling) | [#sig-autoscaling](https://kubernetes.slack.com/messages/sig-autoscaling/) | Biweekly (or triweekly) on [Thurs at 0830 PT](https://plus.google.com/hangouts/_/google.com/k8s-autoscaling) | +| [AWS](sig-aws/README.md) | [@justinsb (Justin Santa Barbara)](https://github.com/justinsb)<br>[@kris-nova (Kris Nova)](https://github.com/kris-nova)<br>[@chrislovecnm (Chris Love)](https://github.com/chrislovecnm)<br>[@mfburnett (Mackenzie Burnett)](https://github.com/mfburnett) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-aws) | [#sig-aws](https://kubernetes.slack.com/messages/sig-aws/) | We meet on [Zoom](https://zoom.us/my/k8ssigaws), and the calls are scheduled via the official [group mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-aws) | +| [Big Data](sig-big-data/README.md) | [@foxish (Anirudh Ramanathan, Google)](https://github.com/foxish)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-big-data) | [#sig-big-data](https://kubernetes.slack.com/messages/sig-big-data/) | Wednesdays at 10am PST, link posted in [the official group](https://groups.google.com/forum/#!forum/kubernetes-sig-big-data). | +| [CLI](sig-cli/README.md) | [@fabianofranz (Fabiano Franz, Red Hat)](https://github.com/fabianofranz)<br>[@pwittrock (Phillip Wittrock, Google)](https://github.com/pwittrock)<br>[@AdoHe (Tony Ado, Alibaba)](https://github.com/AdoHe) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-cli) | [#sig-cli](https://kubernetes.slack.com/messages/sig-cli) | Bi-weekly Wednesdays at 9:00 AM PT on [Zoom](https://zoom.us/my/sigcli) | +| [Cluster Lifecycle](sig-cluster-lifecycle/README.md) | [@lukemarsden (Luke Marsden, Weave)](https://github.com/lukemarsden) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle) | [#sig-cluster-lifecycle](https://kubernetes.slack.com/messages/sig-cluster-lifecycle) | Tuesdays at 09:00 AM PST on [Zoom](https://zoom.us/j/166836624) | +| [Cluster Ops](sig-cluster-ops/README.md) | [@zehicle (Rob Hirschfeld, RackN)](https://github.com/zehicle) <br> [@mikedanese (Mike Danese, Google](https://github.com/mikedanese) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-ops) | [#sig-cluster-ops](https://kubernetes.slack.com/messages/sig-cluster-ops) | Thursdays at 1:00 PM PST on [hangouts](https://plus.google.com/hangouts/_/google.com/sig-cluster-ops)| +| [Contributor Experience](sig-contribx/README.md) | [@grodrigues3 (Garrett Rodrigues, Google)](https://github.com/Grodrigues3) <br> [@pwittrock (Phillip Witrock, Google)](https://github.com/pwittrock) <br> [@Phillels (Elsie Phillips, CoreOS)](https://github.com/Phillels) | [Group](https://groups.google.com/forum/#!forum/kubernetes-wg-contribex) | [#wg-contribex](https://kubernetes.slack.com/messages/wg-contribex) | Biweekly Wednesdays 9:30 AM PST on [zoom](https://zoom.us/j/4730809290) | +| [Docs](sig-docs/README.md) | [@pwittrock (Philip Wittrock, Google)](https://github.com/pwittrock) <br> [@devin-donnelly (Devin Donnelly, Google)](https://github.com/devin-donnelly) <br> [@jaredbhatti (Jared Bhatti, Google)](https://github.com/jaredbhatti)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) | [#sig-docs](https://kubernetes.slack.com/messages/sig-docs) | Tuesdays @ 10:30AM PST on [Zoom](https://zoom.us/j/678394311) | +| [Federation](sig-federation/README.md) | [@csbell (Christian Bell, Google)](https://github.com/csbell) <br> [@quinton-hoole (Quinton Hoole, Huawei)](https://github.com/quinton-hoole) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-federation) | [#sig-federation](https://kubernetes.slack.com/messages/sig-federation/) | Bi-weekly on Monday at 9:00 AM PST on [hangouts](https://plus.google.com/hangouts/_/google.com/ubernetes) | +| [Instrumentation](sig-instrumentation/README.md) | [@piosz (Piotr Szczesniak, Google)](https://github.com/piosz) <br> [@fabxc (Fabian Reinartz, CoreOS)](https://github.com/fabxc) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-instrumentation) | [#sig-instrumentation](https://kubernetes.slack.com/messages/sig-instrumentation) | [Thursdays at 9.30 AM PST](https://zoom.us/j/5342565819) | +| [Network](sig-network/README.md) | [@thockin (Tim Hockin, Google)](https://github.com/thockin)<br> [@dcbw (Dan Williams, Red Hat)](https://github.com/dcbw)<br> [@caseydavenport (Casey Davenport, Tigera)](https://github.com/caseydavenport) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-network) | [#sig-network](https://kubernetes.slack.com/messages/sig-network/) | Thursdays at 2:00 PM PST on [Zoom](https://zoom.us/j/5806599998) | +| [Node](sig-node/README.md) | [@dchen1107 (Dawn Chen, Google)](https://github.com/dchen1107)<br>[@euank (Euan Kemp, CoreOS)](https://github.com/orgs/kubernetes/people/euank)<br>[@derekwaynecarr (Derek Carr, Red Hat)](https://github.com/derekwaynecarr) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-node) | [#sig-node](https://kubernetes.slack.com/messages/sig-node/) | [Tuesdays at 10:00 PT](https://plus.google.com/hangouts/_/google.com/sig-node-meetup?authuser=0) | +| [On Prem](sig-on-prem/README.md) | [@josephjacks (Joseph Jacks, Apprenda)](https://github.com/josephjacks) <br> [@zen (Tomasz Napierala, Mirantis)](https://github.com/zen)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-on-prem) | [#sig-onprem](https://kubernetes.slack.com/messages/sig-onprem/) | Every two weeks on Wednesday at 9 PM PST / 12 PM EST | +| [OpenStack](sig-openstack/README.md) | [@idvoretskyi (Ihor Dvoretskyi, Mirantis)](https://github.com/idvoretskyi) <br> [@xsgordon (Steve Gordon, Red Hat)](https://github.com/xsgordon)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-openstack) | [#sig-openstack](https://kubernetes.slack.com/messages/sig-openstack/) | Every second Wednesday at 5 PM PDT / 2 PM EDT | +| [PM](sig-pm/README.md) | [@apsinha (Aparna Sinha, Google)](https://github.com/apsinha) <br> [@idvoretskyi (Ihor Dvoretskyi, Mirantis)](https://github.com/idvoretskyi) <br> [@calebamiles (Caleb Miles, CoreOS)](https://github.com/calebamiles)| [Group](https://groups.google.com/forum/#!forum/kubernetes-pm) | [#kubernetes-pm](https://kubernetes.slack.com/messages/kubernetes-pm/) | TBD| +| [Rktnetes](sig-rktnetes/README.md) | [@euank (Euan Kemp, CoreOS)](https://github.com/euank) <br> [@tmrts (Tamer Tas)](https://github.com/tmrts) <br> [@yifan-gu (Yifan Gu, CoreOS)](https://github.com/yifan-gu) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-rktnetes) | [#sig-rktnetes](https://kubernetes.slack.com/messages/sig-rktnetes/) | [As needed (ad-hoc)](https://zoom.us/j/830298957) | +| [Scalability](sig-scalability/README.md) | [@lavalamp (Daniel Smith, Google)](https://github.com/lavalamp)<br>[@countspongebob (Bob Wise, Samsung SDS)](https://github.com/countspongebob)<br>[@jbeda (Joe Beda)](https://github.com/jbeda) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-scale) | [#sig-scale](https://kubernetes.slack.com/messages/sig-scale/) | [Thursdays at 09:00 PT](https://zoom.us/j/989573207) | +| [Scheduling](sig-scheduling/README.md) | [@davidopp (David Oppenheimer, Google)](https://github.com/davidopp)<br>[@timothysc (Timothy St. Clair, Red Hat)](https://github.com/timothysc) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-scheduling) | [#sig-scheduling](https://kubernetes.slack.com/messages/sig-scheduling/) | Alternate between Mondays at 1 PM PT and Wednesdays at 12:30 AM PT on [Zoom](https://zoom.us/zoomconference?m=rN2RrBUYxXgXY4EMiWWgQP6Vslgcsn86) | +| [Service Catalog](sig-service-catalog/README.md) | [@pmorie (Paul Morie, Red Hat)](https://github.com/pmorie) <br> [@arschles (Aaron Schlesinger, Deis)](github.com/arschles) <br> [@bmelville (Brendan Melville, Google)](https://github.com/bmelville) <br> [@duglin (Doug Davis, IBM)](https://github.com/duglin)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-service-catalog) | [#sig-service-catalog](https://kubernetes.slack.com/messages/sig-service-catalog/) | [Mondays at 1 PM PST](https://zoom.us/j/7201225346) | +| [Storage](sig-storage/README.md) | [@saad-ali (Saad Ali, Google)](https://github.com/saad-ali)<br>[@childsb (Brad Childs, Red Hat)](https://github.com/childsb) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-storage) | [#sig-storage](https://kubernetes.slack.com/messages/sig-storage/) | Bi-weekly Thursdays 9 AM PST (or more frequently) on [Zoom](https://zoom.us/j/614261834) | +| [Testing](sig-testing/README.md) | [@spiffxp (Aaron Crickenberger, Samsung)](https://github.com/spiffxp)<br>[@ixdy (Jeff Grafton, Google)](https://github.com/ixdy) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-testing) | [#sig-testing](https://kubernetes.slack.com/messages/sig-testing/) | [Tuesdays at 9:30 AM PT](https://zoom.us/j/553910341) | +| [UI](sig-ui/README.md) | [@romlein (Dan Romlein, Apprenda)](https://github.com/romlein)<br> [@bryk (Piotr Bryk, Google)](https://github.com/bryk) | [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-ui) | [#sig-ui](https://kubernetes.slack.com/messages/sig-ui/) | Wednesdays at 4:00 PM CEST | +| [Windows](sig-windows/README.md) | [@michmike77 (Michael Michael, Apprenda)](https://github.com/michmike)| [Group](https://groups.google.com/forum/#!forum/kubernetes-sig-windows) | [#sig-windows](https://kubernetes.slack.com/messages/sig-windows) | Bi-weekly Tuesdays at 9:30 AM PT | + |