Merge branch 'master' into sig_docs_xander
This commit is contained in:
commit
ef0772eccd
|
@ -47,7 +47,6 @@ aliases:
|
|||
- natalisucks
|
||||
- reylejano
|
||||
- salaxander
|
||||
- sftim
|
||||
- tengqm
|
||||
sig-etcd-leads:
|
||||
- ahrtr
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Marketing Lead Handbook
|
||||
# Communications Lead Handbook
|
||||
|
||||
This document defines marketing planning and activities needed to run a
|
||||
This document defines communications and marketing activities needed to run a
|
||||
Contributor Summit.
|
||||
|
||||
- [Overview](#overview)
|
||||
|
@ -11,78 +11,110 @@ Contributor Summit.
|
|||
|
||||
## Overview
|
||||
|
||||
As Marketing Lead, you are responsible for the overall marketing communications
|
||||
timeline. The role also includes ensuring all non-technical content (web, mail,
|
||||
As Communications Lead, you are responsible for the overall marketing communications
|
||||
before, during, and after the event. The role also includes ensuring all non-technical content (web, mail,
|
||||
physical prints) is correct and informative, and supporting the other roles
|
||||
(registration, content) as needed.
|
||||
|
||||
Time Commitment:
|
||||
- 1-3 hours a week from 0-1.5 months in
|
||||
- 2-5 hours a week from 1.5 months-to event
|
||||
- 3-5 hours a week from 1.5 months-to event
|
||||
|
||||
## Skills and Qualifications
|
||||
|
||||
- Good grasp on general marketing activities surrounding events
|
||||
- Good grasp on general marketing activities surrounding events
|
||||
- Understanding of common forms of marketing communications
|
||||
- Event planning experience
|
||||
- If working on the website, you'll need HTML/CSS/JavaScript experience
|
||||
- A healthy emoji vocabulary!
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- Create a communication schedule - what, when, how, who
|
||||
- Manage online presence - website, social media strategy
|
||||
- Potentially recruit a social media coordinator role
|
||||
- Provide updates on social media, mailing lists, and Slack throughout pre-,
|
||||
during-, and post-event
|
||||
- Assist with GitHub event repo adds and edits
|
||||
- Work with Event Lead on a recap blog
|
||||
- Determine signage needs and copy, coordinate with CNCF on explicit needs
|
||||
- Create/update deck templates for curated talks and/or other purposes
|
||||
- Create a communication schedule regarding the event - what, when, how, who
|
||||
- This includes email, Slack, and social media (via the Buffer platform with Contributor Comms)
|
||||
- You'll source the informaton needed from your fellow leads, and can refer to prior art (linked below) for templates
|
||||
- Manage online presence of the website, alongside the social media strategy
|
||||
- Recruit a website lead to handle all updates to the website
|
||||
- Consider ensuring website reviewers/approvers are on the team to merge upstream changes
|
||||
- Provide updates on social media, mailing lists, and Slack before, during, and after the event
|
||||
- After-event communications will include a post-event survey, created by SIG ContribEx leads
|
||||
- Work alongside the CNCF Events Team to coordinate communications efforts
|
||||
- Assist with deck content for curated talks and/or other purposes
|
||||
|
||||
### Communication Channels and Property Access
|
||||
|
||||
Communications to the Kubernetes Contributor Community should be sent from
|
||||
official Kubernetes accounts to ensure they reach the community. Mass messages
|
||||
from personal accounts can easily wind up being marked as spam.
|
||||
from personal accounts can easily wind up being marked as spam. However, in the event
|
||||
that you lead Communications and _aren't_ a member of the [SIG ContribEx Contributor Comms team](/communication/contributor-comms/README.md),
|
||||
personal email accounts can be used. Please check with the current Event Lead and
|
||||
Emeritus Leads on the best course of action.
|
||||
|
||||
**Email**
|
||||
|
||||
Mail should be sent from the contributors@kubernetes.io account. For access, work
|
||||
with the event lead who will coordinate with [SIG Contributor Experience leads]
|
||||
to grant temporary access to the account for the duration of the event.
|
||||
Unless you have access to official Kubernetes accounts, please use your own email account
|
||||
to send all email communications. All emails should include summit-team@kubernetes.io in CC each time.
|
||||
The Event Lead will add all team leads to this distribution list.
|
||||
Outbound communications should always target the main distribution list, dev@kubernetes.io, as well
|
||||
as the co-chairs and tech leads distribution list, leads@kubernetes.io, when necessary.
|
||||
|
||||
**Twitter**
|
||||
While it is appreciated that you triage incoming mail for summit-team@kubernetes.io to
|
||||
varying team leads, you are not responsible for answering all incoming messages. The entire
|
||||
summit planning team should triage and handle their ownership areas when it comes to email communications,
|
||||
respectively.
|
||||
|
||||
Tweets can be sent from two accounts: [@K8sContributors] and [@Kubernetesio].
|
||||
**Website**
|
||||
|
||||
Tweets targeting the greater Kubernetes community should use the [@Kubernetesio]
|
||||
account. Tweets using this account must be coordinated with the [CNCF]. Work
|
||||
with the CNCF events rep to schedule the tweets or put you in contact with
|
||||
the CNCF marketing members in charge of the account. Tweets using this account
|
||||
are often limited in the content and quantity that may be sent.
|
||||
The [Contributor Site](https://www.kubernetes.dev/) should be the source of truth for all Contributor Summit information.
|
||||
As timing, location, registration, and schedule information is confirmed for the event, the website should be populated
|
||||
as soon as possible. The [`OWNERS`](https://github.com/kubernetes/contributor-site/blob/master/OWNERS) file defines
|
||||
who can approve upstream changes.
|
||||
|
||||
Tweets targeting the current contributor base should use the [@K8sContributors]
|
||||
account. There are no restrictions with this account for the amount or kind of
|
||||
messages that may be sent. This account may be used for announcements,
|
||||
live-tweeting, pictures and more. Reach out to the Kubernetes [Contributor Comms] to schedule or use this account.
|
||||
All communications via email and social media should link out to the Contributor Site whenever possible. The
|
||||
["Events"](https://www.kubernetes.dev/events/) top-level page is where all Contributor Summit information is
|
||||
organized, by calendar year.
|
||||
|
||||
**Slack**
|
||||
|
||||
## Shadow to the Marketing Lead Role
|
||||
Slack messaging should be implemented so that all corners of our community are communicated with. Let your emoji power shine!
|
||||
The following channels will be important for all major announcements, plus most reminders:
|
||||
- **#contributor-summit**
|
||||
- **#kubernetes-org-members**
|
||||
- **#chairs-and-techleads**
|
||||
|
||||
This role can include one or more shadows. The Marketing Lead can delegate/assign
|
||||
tasks to the shadows. The expectation from a shadow is to lead one of the
|
||||
events-team roles in an upcoming summit. The shadows to the Marketing Lead are
|
||||
responsible for handling all Marketing lead related activities in the absence of
|
||||
the Lead.
|
||||
Please contact the [SIG ContribEx Contributor Comms team](/communication/contributor-comms/README.md) for access to the Announcement
|
||||
bot in the Kubernetes Slack, which will be useful for broadcasts. The **#contributor-summit** channel should be used for all day-of
|
||||
event communications by you and other summit sub-teams. Contributors and attendees will also ask questions here: this channel should
|
||||
be monitored up until the day of the summit (the Day-of Ops Team will work with you on communications and monitoring on the
|
||||
day of the event).
|
||||
|
||||
**X and Mastodon**
|
||||
|
||||
Tweets can be sent from two accounts: [@K8sContributors](https://twitter.com/K8sContributors) and [@Kubernetesio](https://twitter.com/kubernetesio).
|
||||
Mastodon uses [@K8sContributors](https://hachyderm.io/@K8sContributors) on the hachyderm.io instance.
|
||||
Messaging is coordinated via Buffer, which is owned by the [SIG ContribEx Contributor Comms team](/communication/contributor-comms/README.md).
|
||||
Please work with the Contributor Comms team for access.
|
||||
|
||||
Announcements, live-tweeting, and pictures are all suitable updates for sharing on social media.
|
||||
Most emails sent should have this information mirrored on social media, with links out to the
|
||||
website for further information.
|
||||
|
||||
## Shadow to the Communications Lead Role
|
||||
|
||||
This role should include one or more shadows. The Communications Lead should delegate/assign
|
||||
tasks to the shadows, including the drafting of emails and Slack/social media posts.
|
||||
The expectation from a shadow is to lead one of the summit planning team roles in an upcoming summit.
|
||||
The shadows to the Communications Lead are responsible for handling all Communications Lead-related
|
||||
activities in the absence of the Lead.
|
||||
|
||||
## Documentation
|
||||
|
||||
[Email comms used for Contributor Summit Barcelona, 2019]
|
||||
|
||||
|
||||
[Email comms used for Contributor Summit Barcelona, 2019]: /events/2019/05-contributor-summit/communications.md
|
||||
[SIG Contributor Experience leads]: /sig-contributor-experience/README.md#leadership
|
||||
[@K8sContributors]: https://twitter.com/K8sContributors
|
||||
[@Kubernetesio]: https://twitter.com/kubernetesio
|
||||
[CNCF]: https://www.cncf.io/
|
||||
[SIG-ContribEx Contributor Comms team]: /communication/contributor-comms/README.md
|
||||
- [Email comms used for Contributor Summit EU in Paris, 2024](https://drive.google.com/drive/folders/1m2sRXVp_S37V46jPk9SS3pznFZKq41uI?usp=drive_link) (Requires access – please ask Contributor Comms)
|
||||
- [Email comms used for Contributor Summit EU in Barcelona, 2019](/events/2019/05-contributor-summit/communications.md)
|
||||
- [Contributor Site](https://www.kubernetes.dev/)
|
||||
- [SIG Contributor Experience leads](/sig-contributor-experience/README.md#leadership)
|
||||
- [@K8sContributors on X](https://twitter.com/K8sContributors)
|
||||
- [@Kubernetesio on X](https://twitter.com/kubernetesio)
|
||||
- [@K8sContributors on Mastodon](https://hachyderm.io/@K8sContributors)
|
||||
- [CNCF](https://www.cncf.io/)
|
||||
- [SIG ContribEx Contributor Comms team](/communication/contributor-comms/README.md)
|
||||
|
|
|
@ -52,55 +52,31 @@ This role can include one or more shadows. The Registration Lead can delegate/as
|
|||
### Assembling the Questions and Paths
|
||||
|
||||
Well before the event, collect the information needed for the registration form,
|
||||
and determine the registration workflow. In general this boils down to are they
|
||||
an _"Active/Current Contributor"_ vs a _"New Contributor"_. With a few
|
||||
independent questions for each registration path.
|
||||
and determine the registration workflow.
|
||||
|
||||
For the _"New Contributor"_ path there may be additional paths or questions such
|
||||
as a _"101"_ or _"201"_ track along with other questions that will aid the
|
||||
workshop organizers.
|
||||
|
||||
In addition to any path specific questions, all attendees should be asked the
|
||||
following:
|
||||
All attendees should be asked the following:
|
||||
|
||||
| Question | Type | Required | Notes |
|
||||
|----------------------------------------------------------------|-----------|----------|----------------------------------------------------------------------------------------------------------------|
|
||||
| Name | Free Text | Yes | |
|
||||
| Email | Free Text | Yes | |
|
||||
| GitHub Handle | Free Text | Yes | |
|
||||
| Signed the CLA | Dropdown | Yes | Provide link to CLA. Options: Yes, No - but will do before workshop, No - cannot sign due to work resrictions. |
|
||||
| Food Restrictions | Dropdown | Yes | Options: `none`, `Gluten Free`, `Vegetarian`, `Vegan`, `Other` |
|
||||
| First Name | Free Text | Yes | |
|
||||
| Last Name | Free Text | Yes | |
|
||||
| Job Title | Free Text | Yes | |
|
||||
| Company/Organization | Free Text | Yes | |
|
||||
| GitHub Username *If your GitHub Profile URL is https://github.com/username , only enter username not @username. If you don't have a GitHub username, please enter N/A* | Free Text | Yes | |
|
||||
| Swag Related Question | Dropdown | Yes | Swag question is generally shirt size. |
|
||||
| Please specify dietary needs (if any) | Dropdown | No | Options: `none`, `Gluten Free`, `Vegetarian`, `Vegan`, `Halal`,`Other` |
|
||||
| Do you have a disability that we should be mindful of as we try to accommodate everyone for this event? | Dropdown | No | Options: `Yes`, `No` |
|
||||
| What email did you use to register for KubeCon + CloudNative Con <NA/Europe> <year>? **KubeCon + CloudNative Con <NA/Europe> registration is required to attend Kubernetes Contributor Summit <region> <year>** | Free Text | Yes | |
|
||||
| Are you a member of one of the [Kubernetes GitHub Orgs](http://git.k8s.io/community/github-management#actively-used-github-organizations) | Dropdown | Options: `Yes`, `No` [Pop up if no is selected] Attending the Kubernetes Contributor Summit in-person is limited to Kubernetes Org Members and Sponsored Attendees. If you have questions, please email summit-team@kubernetes.io. Yes | |
|
||||
| What SIGs or WGs are you most active in? Only list the top three. *This will help us plan content and activities.* | Dropdown | Yes | Options: <list all SIGs and WGs> |
|
||||
| What sessions are you most looking forward to? *This will help us plan content and activities.* | Dropdown | No | Options: `Unconference`, `Prepared Presentations`, `Steering AMA`, `SIG Discussions/Working Sessions`, `Impromptu Discussions`, `Social/Mingling` |
|
||||
| What other session(s) would you like to see at the summit? What else would make this event valuable to you? *We've changed content based on contributor feedback to this question in the past.* | Free Text | Yes | |
|
||||
| Social Event | Dropdown | Yes | Required if there is an independent social event. |
|
||||
| Emergency Contact | Free Text | No | Name and Phone Number. Phone number to be verified. |
|
||||
| How can we make this a valuable event for you? | Free Text | No | |
|
||||
| If you had a speaking slot, what would you like to talk about? | Free Text | No | |
|
||||
| Where did you hear about the Contributor Summit? | Checkbox | No | Options: `Twitter`, `mailing list`, `GitHub`, `community meeting`, `SIG/WG Meeting`, `Slack`, `Other` |
|
||||
|
||||
Following are some of the path specific questions that have been asked in the past:
|
||||
|
||||
**New Contributor**
|
||||
|
||||
| Question | Type | Required | Notes |
|
||||
|---------------------------------------------------------------------------------|-----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Laptop availability for workshop | Dropdown | Yes | Should be mentioned that workshop can still be attended if laptop is not available and pair with other participants. Options: Yes, No - do not have a laptop, No - have one but cannot install software on it without IT approval |
|
||||
| Have you joined the kubernetes slack? If so, what is your handle? | Free Text | No | |
|
||||
| Are there any areas of Kubernetes you're already interested in contributing to? | Checkbox | No | Options: `API`, `CLI`, `testing`, `docs`, `community`, `release`, etc |
|
||||
| Are there any SIG's you are interested in joining? | Free Text | No | |
|
||||
| What are you hoping to get out of the contributor summit? | Free Text | No | |
|
||||
| Experience with Go | Dropdown | No | Rate from 1 to 5, with 1 being no experience |
|
||||
| Experience with kubernetes as a user | Dropdown | No | Rate from 1 to 5, with 1 being no experience |
|
||||
| Experience of developing application that integrate with kubernetes | Dropdown | No | Rate from 1 to 5, with 1 being no experience |
|
||||
|
||||
|
||||
**Active Contributor**
|
||||
|
||||
| Question | Type | Required | Notes |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|----------|-------------------------------------|
|
||||
| Are you member of a Kubernetes Github Org? | Dropdown | Yes | |
|
||||
| What SIG's or WG's are you most active in? | Checkbox | Yes | Options: List of the SIG's and WG's |
|
||||
| What session(s) would like to see at the summit? what would make this event valuable to you? We've changed content based on contributor feedback to this question in the past. | Free Text | No | |
|
||||
|
||||
| Where did you hear about the Contributor Summit? | Checkbox | No | Options: `X (formerly Twitter)`, `Mastodon`, `Kubernetes-dev mailing list`, `GitHub`, `Monthly Kubernetes Community Meeting`, `SIG/WG Meeting`, `Slack`, `Kubernetes Blog`, `Other` |
|
||||
|
||||
Additionally, a separate form can be created for registering the `summit staff`.
|
||||
|
||||
|
@ -126,9 +102,6 @@ a system include:
|
|||
- Can it integrate with [sched]? If it can automatically add an attendee, it
|
||||
will make for a less error prone invite process.
|
||||
|
||||
<!--
|
||||
TODO: insert link/note to reg system used for KubeCon CN
|
||||
-->
|
||||
In past events, registration systems that have been used were [Google Forms],
|
||||
[SurveyMonkey], and [cvent]. All have their pluses and minuses.
|
||||
|
||||
|
@ -147,13 +120,41 @@ require going through the LF.
|
|||
Other options exist and should be evaluated when making your decision for the
|
||||
registration system.
|
||||
|
||||
### Communications
|
||||
|
||||
Work with the Communications Lead to include the link to the registration page and future
|
||||
communications efforts to drive registration.
|
||||
|
||||
### Approval Process
|
||||
|
||||
TODO - update doc with new process - query to get org members below:
|
||||
The Kubernetes Contributor Summit is for active contributors to the Kubernetes project.
|
||||
Registrants will be approved if they are org members of one of the following Kubernetes Orgs:
|
||||
kubernetes, kubernetes-client, kubernetes-csi, kubernetes-sigs, etcd-io.
|
||||
|
||||
A SIG lead (co-chair, tech lead, subproject lead) can sponsor a non-org member to attend the summit.
|
||||
Kubernetes Contributor Summit speakers who are non-org members can attend the summit.
|
||||
|
||||
<!--
|
||||
Discussed in the KCSEU 2024 retro, we need to make exception requests less personal
|
||||
We can use an existing method like use the same or similar criteria of the elections
|
||||
or have requests go to the Summit Staff who then ask SIG/WG leads.
|
||||
-->
|
||||
|
||||
There will be a **Kubernetes Contributor Summit Planning Doc** , in the past this
|
||||
was a Google Spreadsheet.
|
||||
|
||||
As soon as the **Kubernetes Contributor Summit Planning Doc** is available, populate
|
||||
the **org - DO NOT DELTE** tab (the name may change in the future but is always the
|
||||
tab that compares if the registrant is an org member) in the
|
||||
**Kubernetes Contributor Summit Planning Doc**.
|
||||
|
||||
There are 2 options to create a list of org members:
|
||||
|
||||
```
|
||||
git clone https://github.com/kubernetes/org.git
|
||||
cd org
|
||||
yq '.admins + .members' \
|
||||
config/etcd-io/org.yaml \
|
||||
config/kubernetes/org.yaml \
|
||||
config/kubernetes-client/org.yaml \
|
||||
config/kubernetes-csi/org.yaml \
|
||||
|
@ -162,37 +163,74 @@ yq '.admins + .members' \
|
|||
| sed -e 's/"//g' > members.txt
|
||||
```
|
||||
|
||||
an alternative is
|
||||
|
||||
```
|
||||
git clone https://github.com/kubernetes/org.git
|
||||
cd org
|
||||
yq '.admins + .members' \
|
||||
config/etcd-io/org.yaml \
|
||||
config/kubernetes/org.yaml \
|
||||
config/kubernetes-client/org.yaml \
|
||||
config/kubernetes-csi/org.yaml \
|
||||
config/kubernetes-sigs/org.yaml \
|
||||
| sed -e 's/---//g' | sed -e 's/- //g' \
|
||||
| sed -e 's/"//g' | sed -e '/^$/d' \
|
||||
| awk '{print tolower($0)}' | sort | uniq > members.txt
|
||||
```
|
||||
|
||||
An approval process for registration is commonly used for multiple reasons, but
|
||||
really boils down to ensuring the right people are in the right track or room.
|
||||
The goal is for all contributors to get the best experience out of the event and
|
||||
that may mean asking them to switch tracks.
|
||||
Populate what's in members.txt in the **org - DO NOT DELTE** tab in the
|
||||
**Kubernetes Contributor Summit Planning Doc**.
|
||||
|
||||
A few scenarios that have occurred:
|
||||
Create a list of staff, shadows, volunteers including day-of volunteers. You can
|
||||
create this list from the GitHub staffing issue e.g. https://github.com/kubernetes/community/issues/7611
|
||||
and query the Summit Staff leads for their day-of volunteers. The Day-of Operations
|
||||
team will likely have volunteers not listed on the GitHub staffing issue.
|
||||
|
||||
**A person has signed up for the New Contributor Workshop, but in their
|
||||
comments have mentioned they are unfamiliar with Kubernetes.**
|
||||
Once the talks for the Kubernetes Contributor Summit have been selected, create
|
||||
a list of speakers and note if any are not org members so they can be approved
|
||||
when they register.
|
||||
|
||||
They may have interpreted the event as an _"Introduction to Kubernetes"_ from an
|
||||
end-user perspective. In this case it is best to reach out to them and provide
|
||||
more context for the event. They will likely apologize and ask to be removed.
|
||||
Review past declined registrants if any are speakers, email them to re-register
|
||||
for the Contributor Summit.
|
||||
|
||||
**A person who looks to be an Active Contributor has signed up for the New
|
||||
Contributor Track.**
|
||||
#### Exception Request Scenarios
|
||||
|
||||
This could be accidental, or in some scenarios a non-code contributor is looking
|
||||
for a better introduction to the code base branch into code-based contributions.
|
||||
**A person is not an org member and would like to attend the Contributor Summit**
|
||||
|
||||
**A person registered for the Active or Current Contributor track, but has not
|
||||
participated with the project.**
|
||||
With 1600+ Kubernetes Org members and limited space and budget requirements, we've
|
||||
made the decision to limit attendance to those that are already actively engaged
|
||||
with the project.
|
||||
|
||||
They may have accidentally selected the wrong track, or believe they should go
|
||||
for other reasons. It is best to reach out let them know about the intended
|
||||
audience and that they may get more out of the other track. Use your best
|
||||
judgement. If you are unsure, reach out to other Event organizers or other
|
||||
members of SIG-Contributor Experience for their opinion on the matter.
|
||||
Contributor Summit speakers without org membership can attend the Contributor Summit.
|
||||
|
||||
A SIG lead (co-chair, tech lead, subproject lead) can sponsor a non-org member to attend the summit,
|
||||
this process is TBD.
|
||||
|
||||
<!--
|
||||
Discussed in the KCSEU 2024 retro, we need to make exception requests less personal
|
||||
We can use an existing method like use the same or similar criteria of the elections
|
||||
or have requests go to the Summit Staff who then ask SIG/WG leads.
|
||||
-->
|
||||
|
||||
**A speaker is not registered for KubeCon + CloudNativeCon**
|
||||
|
||||
KubeCon + CloudNativeCon registration is a requirement to attend the Contributor Summit.
|
||||
Speakers must be registered for KubeCon + CloudNativeCon.
|
||||
|
||||
### Dietary Requirements
|
||||
|
||||
Confirm with the CNCF staff rep on who will keep track of dietary requirements.
|
||||
If there are any email requests, add them to the **Dietary Requirements** tab
|
||||
in the **Kubernetes Contributor Summit Planning Doc** and notify the CNCF staff
|
||||
rep.
|
||||
|
||||
### Celebration Guests
|
||||
|
||||
The CNCF staff may have the ability to keep track of registrants who are bringing
|
||||
a plus 1 to the social. There may be emails to request to bring a plus 1.
|
||||
Add any requests via email to the **Celebration Guests** tab in the
|
||||
**Kubernetes Contributor Summit Planning Doc**.
|
||||
|
||||
#### Helpful Approval Tips and Facts
|
||||
|
||||
|
@ -250,7 +288,11 @@ combined with the post-event survey data, can provide insights in the event
|
|||
itself.
|
||||
|
||||
|
||||
## Registration at the Contributor Summit
|
||||
|
||||
If there is a registration desk / badge pickup at the Contributor Summit,
|
||||
it is helpful to have a Registration Team member at the registration desk during
|
||||
the morning of the Kubernetes Contributor Summit to assist with questions.
|
||||
|
||||
|
||||
[sched]: http://sched.com
|
||||
|
|
|
@ -47,7 +47,6 @@ The Technical Leads of the SIG establish new subprojects, decommission existing
|
|||
subprojects, and resolve cross-subproject technical issues and decisions.
|
||||
|
||||
* Xander Grzywinski (**[@salaxander](https://github.com/salaxander)**), Defense Unicorns
|
||||
* Tim Bannister (**[@sftim](https://github.com/sftim)**), The Scale Factory
|
||||
* Qiming Teng (**[@tengqm](https://github.com/tengqm)**), Sangfor Technologies
|
||||
|
||||
## Emeritus Leads
|
||||
|
@ -60,7 +59,8 @@ subprojects, and resolve cross-subproject technical issues and decisions.
|
|||
* Kaitlyn Barnard (**[@kbarnard10](https://github.com/kbarnard10)**)
|
||||
* Karen Bradshaw (**[@kbhawkey](https://github.com/kbhawkey)**)
|
||||
* Taylor Dolezal (**[@onlydole](https://github.com/onlydole)**)
|
||||
* Zach Corleissen (**[@zacharysarah](https://github.com/zacharysarah)**)
|
||||
* Tim Bannister (**[@sftim](https://github.com/sftim)**)
|
||||
* Sarah Corleissen (**[@zacharysarah](https://github.com/zacharysarah)**)
|
||||
|
||||
## Contact
|
||||
- Slack: [#sig-docs](https://kubernetes.slack.com/messages/sig-docs)
|
||||
|
|
|
@ -19,6 +19,9 @@ The [charter](charter.md) defines the scope and governance of the etcd Special I
|
|||
* Regular SIG Meeting: [Thursdays at 11:00 PT (Pacific Time)](https://zoom.us/my/cncfetcdproject) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=11:00&tz=PT%20%28Pacific%20Time%29).
|
||||
* [Meeting notes and Agenda](https://docs.google.com/document/d/16XEGyPBisZvmmoIHSZzv__LoyOeluC5a4x353CX0SIM/edit?usp=sharing).
|
||||
* [Meeting recordings](https://www.youtube.com/playlist?list=PLRGL688DpO9rtufHbiunuCHddYY6MGkwW).
|
||||
* Robustness Tests Meeting: [Wednesdays at 08:00 PT (Pacific Time)](https://zoom.us/my/cncfetcdproject) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=08:00&tz=PT%20%28Pacific%20Time%29).
|
||||
* [Meeting notes and Agenda](https://docs.google.com/document/d/1idZ_7tV6F18v223LyQ0WVUn9gXLSKyeLwYTdAgbjxpw/edit?usp=sharing).
|
||||
* [Meeting recordings](https://www.youtube.com/playlist?list=PLRGL688DpO9oF-YEEfVXMzaOUzFYK74-I).
|
||||
|
||||
## Leadership
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ When the need arises, a [new SIG can be created](sig-wg-lifecycle.md)
|
|||
|[Cluster Lifecycle](sig-cluster-lifecycle/README.md)|[cluster-lifecycle](https://github.com/kubernetes/kubernetes/labels/sig%2Fcluster-lifecycle)|* [Justin Santa Barbara](https://github.com/justinsb), Google<br>* [Lubomir Ivanov](https://github.com/neolit123), VMware<br>* [Vince Prignano](https://github.com/vincepri), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/sig-cluster-lifecycle)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle)|* Regular SIG Meeting: [Tuesdays at 09:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/916523531?pwd=eVhPNU5IQWtBYWhmT1N4T0V6bHZFZz09)<br>* (cluster-addons) Cluster Addons meeting: [Tuesdays at 09:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/130096731?pwd=U3pzWloxZ0lpbEtadTZGSERRdENrZz09)<br>* (cluster-api) Cluster API office hours: [Wednesdays at 10:00 PT (Pacific Time) (weekly)](https://zoom.us/j/861487554?pwd=dTVGVVFCblFJc0VBbkFqQlU0dHpiUT09)<br>* (cluster-api-provider-aws) Cluster API Provider AWS office hours: [Mondays at 09:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/423312508?pwd=Tk9OWnZ4WHg2T2xRek9xZXA1eFQ4dz09)<br>* (cluster-api-provider-azure) Cluster API Provider Azure office hours: [Thursdays at 09:00 PT (Pacific Time) (weekly)](https://zoom.us/j/566930821?pwd=N2JuRWljc3hGS3ZnVlBLTk42TFlzQT09)<br>* (cluster-api-provider-digitalocean) Cluster API Provider DigitalOcean office hours: [Thursdays at 09:00 PT (Pacific Time) (monthly, second Thursday of the month)](https://zoom.us/j/91312171751?pwd=bndnMDdJMkhySDVncjZoR1VhdFBTZz09)<br>* (cluster-api-provider-ibmcloud) Cluster API Provider IBM Cloud office hours: [Fridays at 09:00 IST (weekly)](https://zoom.us/j/9392903494)<br>* (cluster-api-provider-kubevirt) Cluster API Provider KubeVirt Syncup Meetings: [Tuesdays at 8:00 PT (Pacific Time) (weekly starting Tuesday December 7th, 2021)](https://zoom.us/j/94685513559?pwd=cnI3RUQyZ3RrckpOc1BQNDA1Q1BrZz09)<br>* (cluster-api-provider-nested) Cluster API Provider Nested Office Hours: [Tuesdays at 10:00 PT (Pacific Time) (weekly)](https://zoom.us/j/91929881559?pwd=WllxazhTUzBFN1BNWTRadTA3NGtQQT09)<br>* (cluster-api-provider-openstack) Cluster API Provider OpenStack Office Hours: [Wednesdays at 14:00 UTC (alternate weeks, check agenda doc for last meeting)](https://zoom.us/j/91405526408?pwd=bVBxempwVDBzejJGQlhSOGlXZnRxUT09)<br>* (cluster-api-provider-vsphere) Cluster API vSphere meeting: [Thursdays at 10:00 PT (Pacific Time) (biweekly starting Thursday June 25th, 2020)](https://zoom.us/j/92253194848?pwd=cVVVNDMxeTl1QVJPUlpvLzNSVU1JZz09)<br>* (etcdadm) etcdadm Office Hours: [Mondays at 09:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/612375927?pwd=MldxRnRSOExCVW1rbjM4ZzBSc3MvUT09)<br>* (image-builder) Image Builder office hours: [Mondays at 08:30 PT (Pacific Time) (biweekly)](https://zoom.us/j/807524571?pwd=WEFTeDJzeWU3bVFkcWQ0UEdZRkRCdz09)<br>* (kOps) kOps Office Hours: [Fridays at 09:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/97072789944?pwd=VVlUR3dhN2h5TEFQZHZTVVd4SnJUdz09)<br>* (kubeadm) kubeadm Office Hours: [Wednesdays at 09:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/179916854?pwd=dzRhbjFnRGVQRDVUVHY1a29JV2JxUT09)<br>* (minikube) minikube office hours: [Mondays at 11:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/97017029363?pwd=U3MvZ3pMMHM5eWorSjgzUnd5OEFtUT09)<br>
|
||||
|[Contributor Experience](sig-contributor-experience/README.md)|[contributor-experience](https://github.com/kubernetes/kubernetes/labels/sig%2Fcontributor-experience)|* [Kaslin Fields](https://github.com/kaslin), Google<br>* [Nabarun Pal](https://github.com/palnabarun), VMware<br>|* [Slack](https://kubernetes.slack.com/messages/sig-contribex)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-contribex)|* Regular SIG Meeting: [Wednesdays at 9:00 PT (Pacific Time) (weekly alternating slack/zoom)](https://zoom.us/j/397264241?pwd=bHNnZVArNFdPaWVJMmttdko0Sktudz09)<br>* (contributor-comms) Contributor Comms - Contributor Comms Team Meeting: [Fridays at 8:00 PT (Pacific Time) (weekly)](https://zoom.us/j/596959769?pwd=TURBNlZPb3BEWVFmbWlCYXlMVVJiUT09)<br>* (github-management) GitHub Administration Subproject: [Thursdays at 09:00 PT (Pacific Time) (Monthly on 4th Thursday)](https://zoom.us/j/442435463?pwd=Rk1PWWpSSTJDaWJKdzRYb2EyTlkvZz09)<br>
|
||||
|[Docs](sig-docs/README.md)|[docs](https://github.com/kubernetes/kubernetes/labels/sig%2Fdocs)|* [Divya Mohan](https://github.com/divya-mohan0209), SUSE<br>* [Natali Vlatko](https://github.com/natalisucks), Cisco<br>* [Rey Lejano](https://github.com/reylejano), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/sig-docs)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)|* APAC SIG Meeting: [Wednesdays at 05:30 UTC (monthly - Wednesday, after the fourth Tuesday, every month)](https://docs.google.com/document/d/1emuO4nmaQq3K8JZ9-MQeIygtrCPO9kWv7U7RzTaW4F8/edit)<br>* Korean Team Meeting: [Thursdays at 13:00 UTC (biweekly)](https://docs.google.com/document/d/1h5sMhBpPB5unJmBAS7KzDiPs-_eFQOu5o4UyHwMtFCA/edit)<br>* Localization Subproject Meeting: [Mondays at 15:00 UTC (first Monday of the month)](https://docs.google.com/document/d/1NwO1AN8Ea2zlK8uAdaDAKf1-LZDAFvSewIfrKqfl5No/)<br>* New Contributor Meet and Greet: [Tuesdays at 10:30 UTC (first Tuesday of the month)](https://zoom.us/j/92822621820?pwd=S1p4RnB1RmNSZ3JjYlRRUVd4UjFPZz09)<br>* Regular SIG Meeting: [Tuesdays at 17:30 UTC (biweekly)](https://docs.google.com/document/d/1emuO4nmaQq3K8JZ9-MQeIygtrCPO9kWv7U7RzTaW4F8/edit)<br>* Spanish Team Meeting: [Tuesdays at 15:30 UTC (weekly)](https://zoom.us/j/95918289494?pwd=Wk9Oa0xZUkFXSDV5OTFoZEZsTURCZz09)<br>
|
||||
|[etcd](sig-etcd/README.md)|[etcd](https://github.com/kubernetes/kubernetes/labels/sig%2Fetcd)|* [James Blair](https://github.com/jmhbnz), Red Hat<br>* [Wenjia Zhang](https://github.com/wenjiaswe), Google<br>|* [Slack](https://kubernetes.slack.com/messages/etcd)<br>* [Mailing List](https://groups.google.com/g/etcd-dev)|* Regular SIG Meeting: [Thursdays at 11:00 PT (Pacific Time) (biweekly)](https://zoom.us/my/cncfetcdproject)<br>
|
||||
|[etcd](sig-etcd/README.md)|[etcd](https://github.com/kubernetes/kubernetes/labels/sig%2Fetcd)|* [James Blair](https://github.com/jmhbnz), Red Hat<br>* [Wenjia Zhang](https://github.com/wenjiaswe), Google<br>|* [Slack](https://kubernetes.slack.com/messages/etcd)<br>* [Mailing List](https://groups.google.com/g/etcd-dev)|* Regular SIG Meeting: [Thursdays at 11:00 PT (Pacific Time) (biweekly)](https://zoom.us/my/cncfetcdproject)<br>* Robustness Tests Meeting: [Wednesdays at 08:00 PT (Pacific Time) (biweekly)](https://zoom.us/my/cncfetcdproject)<br>
|
||||
|[Instrumentation](sig-instrumentation/README.md)|[instrumentation](https://github.com/kubernetes/kubernetes/labels/sig%2Finstrumentation)|* [Han Kang](https://github.com/logicalhan), Google<br>* [Pranshu Srivastava](https://github.com/rexagod), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/sig-instrumentation)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-instrumentation)|* Regular SIG Meeting: [Thursdays at 9:30 PT (Pacific Time) (biweekly)](https://zoom.us/j/5342565819?pwd=RlVsK21NVnR1dmE3SWZQSXhveHZPdz09)<br>* Regular Triage Meeting: [Thursdays at 9:30 PT (Pacific Time) (biweekly - alternating with regular meeting)](https://zoom.us/j/5342565819?pwd=RlVsK21NVnR1dmE3SWZQSXhveHZPdz09)<br>
|
||||
|[K8s Infra](sig-k8s-infra/README.md)|[k8s-infra](https://github.com/kubernetes/kubernetes/labels/sig%2Fk8s-infra)|* [Arnaud Meukam](https://github.com/ameukam), VMware<br>* [Davanum Srinivas](https://github.com/dims), Amazon<br>|* [Slack](https://kubernetes.slack.com/messages/sig-k8s-infra)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-k8s-infra)|* Regular SIG Meeting: [Wednesdays at 20:00 UTC (bi-weekly)](https://zoom.us/j/93109963352?pwd=SHJTcFR2bVg1akYxSDREUWQzaldrQT09)<br>* (k8s-infra-dns) Regular SIG Meeting: [Wednesdays at 20:00 UTC (bi-weekly)](https://zoom.us/j/93109963352?pwd=SHJTcFR2bVg1akYxSDREUWQzaldrQT09)<br>* (k8s-infra-groups) Regular SIG Meeting: [Wednesdays at 20:00 UTC (bi-weekly)](https://zoom.us/j/93109963352?pwd=SHJTcFR2bVg1akYxSDREUWQzaldrQT09)<br>* (k8s.io) Regular SIG Meeting: [Wednesdays at 20:00 UTC (bi-weekly)](https://zoom.us/j/93109963352?pwd=SHJTcFR2bVg1akYxSDREUWQzaldrQT09)<br>* (porche) Regular SIG Meeting: [Wednesdays at 20:00 UTC (bi-weekly)](https://zoom.us/j/93109963352?pwd=SHJTcFR2bVg1akYxSDREUWQzaldrQT09)<br>* (registry.k8s.io) Regular SIG Meeting: [Wednesdays at 20:00 UTC (bi-weekly)](https://zoom.us/j/93109963352?pwd=SHJTcFR2bVg1akYxSDREUWQzaldrQT09)<br>
|
||||
|[Multicluster](sig-multicluster/README.md)|[multicluster](https://github.com/kubernetes/kubernetes/labels/sig%2Fmulticluster)|* [Jeremy Olmsted-Thompson](https://github.com/jeremyot), Google<br>* [Paul Morie](https://github.com/pmorie), Apple<br>|* [Slack](https://kubernetes.slack.com/messages/sig-multicluster)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-multicluster)|* Regular SIG Meeting: [Tuesdays at 9:30 PT (Pacific Time) (bi-weekly)](https://zoom.us/my/k8s.mc)<br>
|
||||
|
|
|
@ -1,15 +1,18 @@
|
|||
# Contributing
|
||||
|
||||
The process for contributing code to Kubernetes via the sig-multicluster [community][community page].
|
||||
The process for contributing code to Kubernetes via the sig-multicluster
|
||||
[community][community page].
|
||||
|
||||
## TL;DR
|
||||
|
||||
- See [multicluster.sigs.k8s.io/contributing](https://multicluster.sigs.k8s.io/contributing/)
|
||||
- The sig-multicluster [community page] lists sig-multicluster [leads]
|
||||
and group [meeting] times.
|
||||
- See
|
||||
[multicluster.sigs.k8s.io/contributing](https://multicluster.sigs.k8s.io/contributing/).
|
||||
- The sig-multicluster [community page] lists sig-multicluster [leads] and group
|
||||
[meeting] times.
|
||||
- Request a feature by making an [issue] and mentioning
|
||||
`@kubernetes/sig-multicluster-feature-requests`.
|
||||
- Reach out on Slack in [#sig-multicluster](https://kubernetes.slack.com/messages/sig-multicluster)
|
||||
- Reach out on Slack in
|
||||
[#sig-multicluster](https://kubernetes.slack.com/messages/sig-multicluster)
|
||||
- Write a design proposal before starting work on a new feature.
|
||||
- Write [tests]!
|
||||
|
||||
|
@ -18,13 +21,13 @@ The process for contributing code to Kubernetes via the sig-multicluster [commun
|
|||
Welcome to the Kubernetes sig-multicluster contributing guide. We are excited
|
||||
about the prospect of you joining our [community][community page]!
|
||||
|
||||
Please understand that all contributions to Kubernetes require time
|
||||
and commitment from the project maintainers to review the ux, software
|
||||
design, and code. Mentoring and on-boarding new contributors is done
|
||||
in addition to many other responsibilities.
|
||||
Please understand that all contributions to Kubernetes require time and
|
||||
commitment from the project maintainers to review the ux, software design, and
|
||||
code. Mentoring and on-boarding new contributors is done in addition to many
|
||||
other responsibilities.
|
||||
|
||||
If you are interested in contributing to Kubernetes as a whole there is
|
||||
a top level [contributor's guide][contributors guide]
|
||||
If you are interested in contributing to Kubernetes as a whole there is a top
|
||||
level [contributor's guide][contributors guide]
|
||||
|
||||
### Understand the big picture
|
||||
|
||||
|
@ -36,23 +39,25 @@ Follow the [CLA signup instructions](../CLA.md).
|
|||
|
||||
### Adopt an issue
|
||||
|
||||
New contributors can try the following to work on an existing bug or approved design:
|
||||
New contributors can try the following to work on an existing bug or approved
|
||||
design:
|
||||
|
||||
- In [slack][slack-messages] (signup [here][slack-signup]),
|
||||
@mention a [lead][leads] and ask if there are any issues you could pick up.
|
||||
We also maintain a list of [multi cluster issues where help is wanted][multicluster_help_wanted_issues].
|
||||
Most of them are not very complex, so that's probably a good starting point.
|
||||
Leads can recommend issues that have enough priority to receive PR review bandwidth.
|
||||
- In [slack][slack-messages] (signup [here][slack-signup]), @mention a
|
||||
[lead][leads] and ask if there are any issues you could pick up. Leads can
|
||||
recommend issues that have enough priority to receive PR review bandwidth.
|
||||
- Send an email to the _kubernetes-sig-multicluster@googlegroups.com_ [group]
|
||||
|
||||
> Subject: New sig-multicluster contributor _${yourName}_
|
||||
>
|
||||
> Body: Hello, my name is _${yourName}_. I would like to get involved in
|
||||
> contributing to the Kubernetes project. I have read all of the
|
||||
> user documentation listed on the community contributing page.
|
||||
> What should I do next to get started?
|
||||
> contributing to the Kubernetes project. I have read all of the user
|
||||
> documentation listed on the community contributing page. What should I do
|
||||
> next to get started?
|
||||
|
||||
- Attend a sig-multicluster [meeting] and introduce yourself as looking to get started.
|
||||
- Attend a sig-multicluster [meeting] and introduce yourself as looking to get
|
||||
started.
|
||||
- Browse through the open issues in the subprojects of SIG-Multicluster,
|
||||
especially ones with the "help-wanted" tag.
|
||||
|
||||
### Bug lifecycle
|
||||
|
||||
|
@ -75,28 +80,32 @@ New contributors can try the following to work on an existing bug or approved de
|
|||
|
||||
__New contributors:__ Please start by adopting an [existing issue].
|
||||
|
||||
A feature request is an [issue] mentioning `@kubernetes/sig-multicluster-feature-requests`.
|
||||
A feature request is an [issue] mentioning
|
||||
`@kubernetes/sig-multicluster-feature-requests`.
|
||||
|
||||
To encourage readership, the issue description should _concisely_ (2-4 sentence) describe
|
||||
the problem that the feature addresses.
|
||||
To encourage readership, the issue description should _concisely_ (2-4 sentence)
|
||||
describe the problem that the feature addresses.
|
||||
|
||||
### Feature lifecycle
|
||||
|
||||
Working on a feature without getting approval for the user experience
|
||||
and software design often results in wasted time and effort due to
|
||||
decisions around names and user experience.
|
||||
Working on a feature without getting approval for the user experience and
|
||||
software design often results in wasted time and effort due to decisions around
|
||||
names and user experience.
|
||||
|
||||
To minimize wasted work and improve communication across efforts,
|
||||
the user experience and software design must be agreed upon before
|
||||
any PRs are sent for code review.
|
||||
To minimize wasted work and improve communication across efforts, the user
|
||||
experience and software design must be agreed upon before any PRs are sent for
|
||||
code review.
|
||||
|
||||
1. Identify a problem by filing an [issue] (mention `@kubernetes/sig-multicluster-feature-requests`).
|
||||
2. Submit a [design proposal] and get it approved by a lead.
|
||||
1. Identify a problem by filing an [issue] (mention
|
||||
`@kubernetes/sig-multicluster-feature-requests`).
|
||||
2. Share a design proposal and get community feedback.
|
||||
3. Announce the proposal as an [agenda] item for the sig-multicluster [meeting].
|
||||
- Ensures awareness and feedback.
|
||||
- Should be included in meeting notes sent to the sig-multicluster [group].
|
||||
4. _Merge_ the proposal PR after approval and announcement.
|
||||
5. A [lead][leads] adds the associated feature to the [feature repo], ensuring that
|
||||
4. _Merge_ the associated KEP PR (if applicable) as provisional after approval
|
||||
and announcement.
|
||||
5. A [lead][leads] sponsors the review and approval process of the KEP, ensuring
|
||||
that
|
||||
- release-related decisions are properly made and communicated,
|
||||
- API changes are vetted,
|
||||
- testing is completed,
|
||||
|
@ -104,73 +113,64 @@ any PRs are sent for code review.
|
|||
- feature is designated _alpha_, _beta_ or _GA_.
|
||||
6. Implement the code per discussion in [bug lifecycle][bug].
|
||||
7. Update docs.
|
||||
8. Wait for your feature to appear in the next Kubernetes release!
|
||||
8. Wait for your feature to appear in the next Kubernetes or SIG-MC subproject
|
||||
release!
|
||||
|
||||
|
||||
## Design Proposals
|
||||
## Design Proposals and KEPs
|
||||
|
||||
__New contributors:__ Please start by adopting an [existing issue].
|
||||
|
||||
A design proposal is a single markdown document in the [design repo]
|
||||
that follows the [design template].
|
||||
|
||||
To make one,
|
||||
- Prepare the markdown document as a PR to that repo.
|
||||
- Avoid _Work In Progress_ (WIP) PRs (send it only after
|
||||
you consider it complete).
|
||||
- For early feedback, use the email discussion [group].
|
||||
- Mention `@kubernetes/sig-multicluster-proposals` in the description.
|
||||
- Mention the related [feature request].
|
||||
A design proposal is an informal Google doc or similar shared with members of
|
||||
the community through the mailing list [group] or at a regular SIG-Multicluster
|
||||
[meeting] by adding it to the [agenda].
|
||||
|
||||
Expect feedback from 2-3 different sig-multicluster community members.
|
||||
|
||||
Incorporate feedback and comment [`PTAL`].
|
||||
Once a [lead][leads] has agreed that design and code review resources can be
|
||||
allocated to tackle the proposal, the details of the user experience and design
|
||||
should be discussed in the community.
|
||||
|
||||
Once a [lead][leads] has agreed (via review commentary) that design
|
||||
and code review resources can be allocated to tackle the proposal, the
|
||||
details of the user experience and design should be discussed in the
|
||||
community.
|
||||
|
||||
This step is _important_; it prevents code churn and thrashing around
|
||||
issues like flag names, command names, etc.
|
||||
This step is _important_; it prevents code churn and thrashing around issues
|
||||
like flag names, command names, etc.
|
||||
|
||||
It is normal for sig-multicluster community members to push back on feature
|
||||
proposals. sig-multicluster development and review resources are extremely
|
||||
constrained. Community members are free to say
|
||||
|
||||
- No, not this release (or year).
|
||||
- This is desirable but we need help on these other existing issues before tackling this.
|
||||
- This is desirable but we need help on these other existing issues before
|
||||
tackling this.
|
||||
- No, this problem should be solved in another way.
|
||||
|
||||
The proposal can be merged into the [design repo] after [lead][leads]
|
||||
approval and discussion as a meeting [agenda] item.
|
||||
Usually at this point the design proposal will be reformatted into a KEP and
|
||||
follow the [KEP process] like other [multicluster KEPs], even if the
|
||||
implementation is out-of-tree and not tied to a specific Kubernetes release.
|
||||
|
||||
Then coding can begin.
|
||||
|
||||
## Implementation
|
||||
|
||||
Contributors can begin implementing a feature before any of the above
|
||||
steps have been completed, but _should not send a PR until
|
||||
the [design proposal] has been merged_.
|
||||
Contributors can begin implementing a feature before any of the above steps have
|
||||
been completed, but _should not send a PR until the [KEP][multicluster KEPs] has
|
||||
been merged_.
|
||||
|
||||
See the [development guide] for instructions on setting up the
|
||||
Kubernetes development environment.
|
||||
See the [development guide] for instructions on setting up the Kubernetes
|
||||
development environment.
|
||||
|
||||
Implementation PRs should
|
||||
- mention the issue of the associated design proposal,
|
||||
- mention `@kubernetes/sig-multicluster-pr-reviews`,
|
||||
- mention the issue of the associated KEP,
|
||||
- __include tests__.
|
||||
|
||||
Small features and flag changes require only unit/integration tests,
|
||||
while larger changes require both unit/integration tests and e2e tests.
|
||||
Small features and flag changes require only unit/integration tests, while
|
||||
larger changes require both unit/integration tests and e2e tests.
|
||||
|
||||
### Report progress
|
||||
|
||||
_Leads need your help to ensure that progress is made to
|
||||
get the feature into a [release]._
|
||||
_Leads need your help to ensure that progress is made to get the feature into a
|
||||
[release]._
|
||||
|
||||
While working on the issue, leave a weekly update on the issue
|
||||
including:
|
||||
While working on the issue, leave a weekly update on the issue including:
|
||||
|
||||
1. What's finished?
|
||||
2. What's part is being worked on now?
|
||||
|
@ -181,18 +181,22 @@ including:
|
|||
|
||||
_Let users know about cool new features by updating user facing documentation._
|
||||
|
||||
Depending on the contributor and size of the feature, this
|
||||
may be done either by the same contributor that implemented the feature,
|
||||
or another contributor who is more familiar with the existing docs
|
||||
templates.
|
||||
Depending on the contributor and size of the feature, this may be done either by
|
||||
the same contributor that implemented the feature, or another contributor who is
|
||||
more familiar with the existing docs templates.
|
||||
|
||||
## Release
|
||||
|
||||
Several weeks before a Kubernetes release, development enters a stabilization
|
||||
period where no new features are merged. For a feature to be accepted
|
||||
into a release, it must be fully merged and tested by this time. If
|
||||
your feature is not fully complete, _including tests_, it will have
|
||||
to wait until the next release.
|
||||
Many of the subprojects in SIG-Multicluster are "out-of-tree", meaning they are
|
||||
not tied to the core Kubernetes release process. For such features, changes can
|
||||
be merged at any time at the discretion of the code owners.
|
||||
|
||||
For features requiring a change in core Kubernetes, several weeks before a
|
||||
Kubernetes release, development enters a stabilization period where no new
|
||||
features are merged. For a feature to be accepted into a release, it must be
|
||||
fully merged and tested by this time. If your feature is not fully complete,
|
||||
_including tests_, it will have to wait until the next release. Check the
|
||||
[kubernetes release calendar] for timelines.
|
||||
|
||||
## Merge state meanings
|
||||
|
||||
|
@ -200,8 +204,8 @@ to wait until the next release.
|
|||
- Ready to be implemented.
|
||||
- Unmerged:
|
||||
- Experience and design still being worked out.
|
||||
- Not a high priority issue but may implement in the future: revisit
|
||||
in 6 months.
|
||||
- Not a high priority issue but may implement in the future: revisit in 6
|
||||
months.
|
||||
- Unintentionally dropped.
|
||||
- Closed:
|
||||
- Not something we plan to implement in the proposed manner.
|
||||
|
@ -214,50 +218,50 @@ to wait until the next release.
|
|||
If an issue isn't getting any attention and is unresolved, mention
|
||||
`@kubernetes/sig-multicluster-bugs`.
|
||||
|
||||
Highlight the severity and urgency of the issue. For severe issues
|
||||
escalate by contacting sig [leads] and attending the [meeting].
|
||||
Highlight the severity and urgency of the issue. For severe issues escalate by
|
||||
contacting sig [leads] and attending the [meeting].
|
||||
|
||||
### If your feature request issue is stuck
|
||||
|
||||
If an issue isn't getting any attention and is unresolved, mention
|
||||
`@kubernetes/sig-multicluster-feature-requests`.
|
||||
|
||||
If a particular issue has a high impact for you or your business,
|
||||
make sure this is clear on the bug, and reach out to the sig leads
|
||||
directly. Consider attending the sig meeting to discuss over video
|
||||
conference.
|
||||
If a particular issue has a high impact for you or your business, make sure this
|
||||
is clear on the bug, and reach out to the sig leads directly. Consider
|
||||
attending the sig meeting to discuss over video conference.
|
||||
|
||||
### If your PR is stuck
|
||||
|
||||
It may happen that your PR seems to be stuck without clear actionable
|
||||
feedback for a week or longer. A PR _associated with a bug or design
|
||||
proposal_ is much less likely to be stuck than a dangling PR.
|
||||
It may happen that your PR seems to be stuck without clear actionable feedback
|
||||
for a week or longer. A PR _associated with a bug or design proposal_ is much
|
||||
less likely to be stuck than a dangling PR.
|
||||
|
||||
However, if it happens do the following:
|
||||
|
||||
- If your PR is stuck for a week or more because it has never gotten any
|
||||
comments, mention `@kubernetes/sig-multicluster-pr-reviews` and ask for attention.
|
||||
- If your PR is stuck for a week or more _after_ it got comments, but
|
||||
the attention has died down. Mention the reviewer and comment with
|
||||
[`PTAL`].
|
||||
comments, mention `@kubernetes/sig-multicluster-pr-reviews` and ask for
|
||||
attention.
|
||||
- If your PR is stuck for a week or more _after_ it got comments, but the
|
||||
attention has died down. Mention the reviewer and comment with [`PTAL`].
|
||||
|
||||
If you are still not able to get any attention after a couple days,
|
||||
escalate to sig [leads] by mentioning them.
|
||||
If you are still not able to get any attention after a couple days, escalate to
|
||||
sig [leads] by mentioning them.
|
||||
|
||||
### If your design proposal issue is stuck
|
||||
### If your design proposal is stuck
|
||||
|
||||
It may happen that your design doc gets stuck without getting merged
|
||||
or additional feedback. If you believe that your design is important
|
||||
and has been dropped, or it is not moving forward, please add it to
|
||||
the sig multicluster bi-weekly meeting [agenda] and mail the [group] saying
|
||||
you'd like to discuss it.
|
||||
It may happen that your design doc gets stuck without getting merged or
|
||||
additional feedback. If you believe that your design is important and has been
|
||||
dropped, or it is not moving forward, please add it to the sig multicluster
|
||||
bi-weekly meeting [agenda] and mail the [group] saying you'd like to discuss it.
|
||||
|
||||
### General escalation instructions
|
||||
|
||||
See the sig-multicluster [community page] for points of contact and meeting times:
|
||||
See the sig-multicluster [community page] for points of contact and meeting
|
||||
times:
|
||||
|
||||
- attend the sig-multicluster [meeting]
|
||||
- message one of the sig leads on [slack][slack-messages] (signup [here][slack-signup])
|
||||
- message one of the sig leads on [slack][slack-messages] (signup
|
||||
[here][slack-signup])
|
||||
- send an email to the _kubernetes-sig-multicluster@googlegroups.com_ [group].
|
||||
|
||||
## Use of [@mentions]
|
||||
|
@ -268,17 +272,21 @@ See the sig-multicluster [community page] for points of contact and meeting time
|
|||
- `@kubernetes/sig-multicluster-feature-requests` flags a feature request.
|
||||
- `@kubernetes/sig-multicluster-proposals` flags a design proposal.
|
||||
|
||||
[@mentions]: https://help.github.com/articles/basic-writing-and-formatting-syntax/#mentioning-users-and-teams
|
||||
[Kubernetes Basics Tutorial]: https://kubernetes.io/docs/tutorials/kubernetes-basics
|
||||
[@mentions]:
|
||||
https://help.github.com/articles/basic-writing-and-formatting-syntax/#mentioning-users-and-teams
|
||||
[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
|
||||
[agenda]: https://docs.google.com/document/d/18mk62nOXE_MCSSnb4yJD_8UadtzJrYyJxFwbrgabHe8/edit
|
||||
[multicluster KEPs]:
|
||||
[https://github.com/kubernetes/enhancements](https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster)
|
||||
[KEP process]: https://github.com/kubernetes/enhancements
|
||||
[agenda]:
|
||||
https://docs.google.com/document/d/18mk62nOXE_MCSSnb4yJD_8UadtzJrYyJxFwbrgabHe8/edit
|
||||
[bug]: #bug-lifecycle
|
||||
[community page]: /sig-multicluster
|
||||
[contributors guide]: /contributors/guide
|
||||
[design proposal]: #design-proposals
|
||||
[design repo]: https://git.k8s.io/design-proposals-archive/multicluster
|
||||
[design template]: https://git.k8s.io/design-proposals-archive/Design_Proposal_TEMPLATE.md
|
||||
[development guide]: /contributors/devel/development.md
|
||||
[existing issue]: #adopt-an-issue
|
||||
[feature repo]: https://github.com/kubernetes/features
|
||||
|
@ -286,13 +294,18 @@ See the sig-multicluster [community page] for points of contact and meeting time
|
|||
[feature]: https://github.com/kubernetes/features
|
||||
[group]: https://groups.google.com/forum/#!forum/kubernetes-sig-multicluster
|
||||
[issue]: https://github.com/kubernetes/kubernetes/issues
|
||||
[multicluster_help_wanted_issues]: https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted"+label%3Asig%2Fmulticluster
|
||||
[kubectl concept docs]: https://git.k8s.io/kubernetes.github.io/docs/concepts/tools/kubectl
|
||||
[multicluster_help_wanted_issues]:
|
||||
https://github.com/kubernetes/kubernetes/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted"+label%3Asig%2Fmulticluster
|
||||
[kubectl concept docs]:
|
||||
https://git.k8s.io/kubernetes.github.io/docs/concepts/tools/kubectl
|
||||
[kubectl docs]: https://kubernetes.io/docs/user-guide/kubectl-overview
|
||||
[kubernetes/cmd/kubectl]: https://git.k8s.io/kubernetes/cmd/kubectl
|
||||
[kubernetes/pkg/kubectl]: https://git.k8s.io/kubernetes/pkg/kubectl
|
||||
[kubernetes release calendar]:
|
||||
https://calendar.google.com/calendar/u/0/embed?src=agst.us_b07popf7t4avmt4km7eq5tk5ao@group.calendar.google.com
|
||||
[leads]: /sig-multicluster#leads
|
||||
[management overview]: https://kubernetes.io/docs/concepts/tools/kubectl/object-management-overview
|
||||
[management overview]:
|
||||
https://kubernetes.io/docs/concepts/tools/kubectl/object-management-overview
|
||||
[meeting]: /sig-multicluster#meetings
|
||||
[release]: #release
|
||||
[slack-messages]: https://kubernetes.slack.com/messages/sig-multicluster
|
||||
|
|
|
@ -40,8 +40,8 @@ The Chairs of the SIG run operations and processes governing the SIG.
|
|||
- [@kubernetes/sig-multicluster-feature-requests](https://github.com/orgs/kubernetes/teams/sig-multicluster-feature-requests) - Feature Requests
|
||||
- [@kubernetes/sig-multicluster-misc](https://github.com/orgs/kubernetes/teams/sig-multicluster-misc) - General Discussion
|
||||
- [@kubernetes/sig-multicluster-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-multicluster-pr-reviews) - PR Reviews
|
||||
- [@kubernetes/sig-multicluster-proposals](https://github.com/orgs/kubernetes/teams/sig-multicluster-proposals) - Design Proposals
|
||||
- [@kubernetes/sig-multicluster-test-failures](https://github.com/orgs/kubernetes/teams/sig-multicluster-test-failures) - Test Failures and Triage
|
||||
- [@kubernetes/sig-mutlicluster-proposals](https://github.com/orgs/kubernetes/teams/sig-mutlicluster-proposals) - Design Proposals
|
||||
- Steering Committee Liaison: Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**)
|
||||
|
||||
## Working Groups
|
||||
|
|
|
@ -77,7 +77,7 @@ Help in this area will be very appreciated.
|
|||
|
||||
|
||||
**New in 2023:**
|
||||
- [resource-management](https://git.k8s.io/community/<no value>#resource-management)
|
||||
- [resource-management](https://git.k8s.io/community/sig-node#resource-management)
|
||||
|
||||
**Retired in 2023:**
|
||||
- noderesourcetopology-api
|
||||
|
|
19
sigs.yaml
19
sigs.yaml
|
@ -1540,9 +1540,6 @@ sigs:
|
|||
- github: salaxander
|
||||
name: Xander Grzywinski
|
||||
company: Defense Unicorns
|
||||
- github: sftim
|
||||
name: Tim Bannister
|
||||
company: The Scale Factory
|
||||
- github: tengqm
|
||||
name: Qiming Teng
|
||||
company: Sangfor Technologies
|
||||
|
@ -1563,8 +1560,10 @@ sigs:
|
|||
name: Karen Bradshaw
|
||||
- github: onlydole
|
||||
name: Taylor Dolezal
|
||||
- github: sftim
|
||||
name: Tim Bannister
|
||||
- github: zacharysarah
|
||||
name: Zach Corleissen
|
||||
name: Sarah Corleissen
|
||||
meetings:
|
||||
- description: APAC SIG Meeting
|
||||
day: Wednesday
|
||||
|
@ -1707,6 +1706,14 @@ sigs:
|
|||
url: https://zoom.us/my/cncfetcdproject
|
||||
archive_url: https://docs.google.com/document/d/16XEGyPBisZvmmoIHSZzv__LoyOeluC5a4x353CX0SIM/edit?usp=sharing
|
||||
recordings_url: https://www.youtube.com/playlist?list=PLRGL688DpO9rtufHbiunuCHddYY6MGkwW
|
||||
- description: Robustness Tests Meeting
|
||||
day: Wednesday
|
||||
time: "08:00"
|
||||
tz: PT (Pacific Time)
|
||||
frequency: biweekly
|
||||
url: https://zoom.us/my/cncfetcdproject
|
||||
archive_url: https://docs.google.com/document/d/1idZ_7tV6F18v223LyQ0WVUn9gXLSKyeLwYTdAgbjxpw/edit?usp=sharing
|
||||
recordings_url: https://www.youtube.com/playlist?list=PLRGL688DpO9oF-YEEfVXMzaOUzFYK74-I
|
||||
contact:
|
||||
slack: etcd
|
||||
mailing_list: https://groups.google.com/g/etcd-dev
|
||||
|
@ -2093,10 +2100,10 @@ sigs:
|
|||
description: General Discussion
|
||||
- name: sig-multicluster-pr-reviews
|
||||
description: PR Reviews
|
||||
- name: sig-multicluster-proposals
|
||||
description: Design Proposals
|
||||
- name: sig-multicluster-test-failures
|
||||
description: Test Failures and Triage
|
||||
- name: sig-mutlicluster-proposals
|
||||
description: Design Proposals
|
||||
liaison:
|
||||
github: mrbobbytables
|
||||
name: Bob Killen
|
||||
|
|
|
@ -42,4 +42,14 @@ The [charter](charter.md) defines the scope and governance of the Serving Workin
|
|||
- Steering Committee Liaison: Maciej Szulik (**[@soltysh](https://github.com/soltysh)**)
|
||||
<!-- BEGIN CUSTOM CONTENT -->
|
||||
|
||||
## WorkStreams
|
||||
|
||||
The WG-Serving will operate in WorkStreams, each focused on a specific area of work. The following WorkStreams are currently active:
|
||||
|
||||
- [WS Autoscaling](https://docs.google.com/document/d/1QsN4ubjerEqo5L4bQamOFFS2lmCv5zNPis2Z8gcIITg/edit?usp=sharing)
|
||||
<!---
|
||||
Add Links to the WorkStreams documents
|
||||
--->
|
||||
- WS MultiHost/MultiNode
|
||||
- WS Orchestration
|
||||
<!-- END CUSTOM CONTENT -->
|
||||
|
|
|
@ -12,22 +12,25 @@
|
|||
- white papers
|
||||
- work not tracked in KEPs
|
||||
-->
|
||||
- Graduated [contextual logging](https://github.com/kubernetes/enhancements/issues/3077) as Beta.
|
||||
- All of kube-controller-manager and some parts of kube-scheduler converted (in-tree).
|
||||
- klog package updates that support using slog as a backend.
|
||||
- Enhance the logcheck tool for better detection of contextual logging and use newer APIs in Kubernetes.
|
||||
|
||||
2. Are there any areas and/or subprojects that your group needs help with (e.g. fewer than 2 active OWNERS)?
|
||||
- Our working group is looking for more contributors to help us in [the migration of contextual logging](https://github.com/kubernetes/enhancements/issues/3077).
|
||||
If you are interested or experienced in the area, we would very much welcome your participation.
|
||||
|
||||
## Operational
|
||||
|
||||
Operational tasks in [wg-governance.md]:
|
||||
|
||||
- [ ] [README.md] reviewed for accuracy and updated if needed
|
||||
- [ ] WG leaders in [sigs.yaml] are accurate and active, and updated if needed
|
||||
- [ ] Meeting notes and recordings for 2023 are linked from [README.md] and updated/uploaded if needed
|
||||
- [ ] Updates provided to sponsoring SIGs in 2023
|
||||
- [$sig-name](https://git.k8s.io/community/$sig-id/)
|
||||
- links to email, meeting notes, slides, or recordings, etc
|
||||
- [$sig-name](https://git.k8s.io/community/$sig-id/)
|
||||
- links to email, meeting notes, slides, or recordings, etc
|
||||
-
|
||||
- [x] [README.md] reviewed for accuracy and updated if needed
|
||||
- [x] WG leaders in [sigs.yaml] are accurate and active, and updated if needed
|
||||
- [x] Meeting notes and recordings for 2023 are linked from [README.md] and updated/uploaded if needed
|
||||
- [x] Updates provided to sponsoring SIGs in 2023
|
||||
- [SIG Instrumentation](https://git.k8s.io/community/sig-instrumentation/)
|
||||
- [KubeCon China 2023](https://sched.co/1PTJw)
|
||||
|
||||
[wg-governance.md]: https://git.k8s.io/community/committee-steering/governance/wg-governance.md
|
||||
[README.md]: https://git.k8s.io/community/wg-structured-logging/README.md
|
||||
|
|
Loading…
Reference in New Issue