Skip to content

Commit 1fe4707

Browse files
committed
add: subproject recognition in mailing list guidelines
1 parent f496e21 commit 1fe4707

File tree

1 file changed

+95
-55
lines changed

1 file changed

+95
-55
lines changed

communication/mailing-list-guidelines.md

Lines changed: 95 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
11
# Mailing list guidelines
22

3-
The Kubernetes Mailing list or Google Groups functions as the primary means of
3+
The Kubernetes mailing list or Google Groups functions as the primary means of
44
asynchronous communication for the project's
5-
[Special Interest Groups (SIG)][sig-list] and [Working Groups (WG)][sig-list].
5+
[Special Interest Groups (SIG)][sig-list], [Working Groups (WG)][sig-list], and
6+
large subprojects.
67

7-
### ATTENTION: SIG/WG Mailing list owners
8+
### ATTENTION: SIG/WG/Subproject Mailing list owners
89

9-
If you are currently a moderator of a SIG or WG Mailing List. See the new policy
10-
requirements here:
10+
If you are currently a moderator of a SIG, WG, or subproject mailing list,
11+
see the new policy requirements here:
1112

1213
- [Mailing list annual review](#annual-permissions-review)
1314
- [Mailing list moderation queue](#new-user-posting-queue)
1415
- [Creating moderation queue](#create-moderation-queue)
1516

16-
17+
## Table of Contents
18+
- [Code of conduct](#code-of-conduct)
19+
- [Admins](#admins)
20+
- [Mailing list owners](#mailing-list-owners)
21+
- [Moderation](#moderation)
22+
- [Moderator expectations and guidelines](#moderator-expectations-and-guidelines)
23+
- [New user posting queue](#new-user-posting-queue)
24+
- [Annual permissions review](#annual-permissions-review)
25+
- [Mailing list creation](#mailing-list-creation)
26+
- [Prerequisites for creating a mailing list](#prerequisites-for-creating-a-mailing-list)
27+
- [Create the leads and members mailing lists](#create-the-leads-and-members-mailing-lists)
28+
- [Set up shared calendars and meeting with a mailing list](#set-up-shared-calendars-and-meeting-with-a-mailing-list)
29+
- [Prerequisites for sharing a calendar and meeting notes](#prerequisites-for-sharing-a-calendar-and-meeting-notes)
30+
- [Sharing the calendar with the Google Group](#sharing-the-calendar-with-the-google-group)
31+
- [Sharing the meeting notes with the Google Group](#sharing-the-meeting-notes-with-the-google-group)
32+
- [Archive a mailing list](#archive-a-mailing-list)
1733
## Code of conduct
1834

1935
The Kubernetes project adheres to the community [Code of Conduct] throughout all
@@ -23,35 +39,36 @@ platforms and includes all communication mediums.
2339

2440
Check the [centralized list of administrators][admins] for contact information.
2541

26-
To connect: Reach out to one of the listed moderators,[Mailing list owners],
27-
the [sig contributor experience Mailing list] or the `#sig-contribex` slack
42+
To connect: Reach out to one of the listed moderators, [mailing list owners],
43+
the [SIG Contributor Experience mailing list] or the `#sig-contribex` slack
2844
channel.
2945

3046
### Mailing list owners
3147

32-
Mailing list owners should include the Chairs for your [SIG or WG][sig-list] and
33-
the below contacts:
48+
Mailing list owners should include the Chairs for your [SIG or WG][sig-list],
49+
or the leads for your subproject, and the below contacts:
3450

3551
3652

3753
---
3854

3955
## Moderation
4056

41-
SIG and Working Group Mailing lists should have the [Mailing list owners] as
42-
co-owners to the list so that administrative functions can be managed centrally
43-
across the project.
57+
SIG, Working Group, and subproject mailing lists should have the
58+
[mailing list owners] as co-owners to the list so that administrative functions
59+
can be managed centrally across the project.
4460

45-
Moderation of the SIG/WG lists is up to that individual SIG/WG. The admins
46-
are there to help facilitate leadership changes, or various other administrative
47-
functions.
61+
Moderation of the SIG/WG/subproject lists is up to that individual
62+
SIG/WG/subproject. The admins are there to help facilitate leadership changes,
63+
or various other administrative functions.
4864

4965
Users who are violating the [Code of Conduct] or other negative activities
5066
(like spamming) should be moderated.
5167
- [Lock the thread immediately] so that people cannot reply to the thread.
5268
- [Delete the post].
5369
- In some cases you might need to ban a user from the group, follow
54-
[these instructions] on how stop a member from being able to post to the group.
70+
[these instructions] on how stop a member from being able to post to the
71+
group.
5572
For more technical help on how to use Google Groups, check the [Groups Help]
5673
page.
5774

@@ -64,50 +81,60 @@ Moderators should adhere to the general Kubernetes project
6481

6582
#### New user posting queue
6683

67-
New members who post to the Mailing list will automatically have their messages
84+
New members who post to the mailing list will automatically have their messages
6885
put in the [moderation queue]. Moderators of the list will receive a
6986
notification of their message and should process them accordingly.
7087

7188

7289
#### Annual permissions review
7390

74-
SIG and WG Moderators must establish an annual review of their Mailing lists
75-
to ensure their Moderator list is current and includes [Mailing List owners].
76-
Many of the SIG and WG Mailing lists pre-date current communication policy and
77-
an annual review ensures ownership is up to date.
91+
SIG, WG, and subproject Moderators must establish an annual review of their
92+
mailing lists to ensure their Moderator list is current and includes
93+
[mailing list owners]. Many of the SIG and WG mailing lists pre-date current
94+
communication policy and an annual review ensures ownership is up to date.
7895

7996
This review does not need to occur at a specific recurring date and can be
80-
combined with other actions such as SIG/WG leadership changes or sub-project
81-
additions.
97+
combined with other actions such as SIG/WG/subproject leadership changes or
98+
sub-project additions.
8299

83100

84101
---
85102

86103
## Mailing list creation
87104

88-
All SIGs and WGs need two discussion groups: one for leads/chairs, and one for members.
105+
All SIGs and WGs require two discussion groups: one for leads/chairs, and one
106+
for members. Subprojects that opt to have a mailing list only require one for
107+
members.
89108

90-
### Prerequisites
109+
### Prerequisites for creating a mailing list
91110

92-
- An email account that can create google groups and add members external to your organization to a google group mailing list. **This might not be possible with your employer's email account**. You might need to use a personal email account.
93-
- At least 3 mailing list owners (leads), in addition to [email protected]
94-
- Familiarity with the [moderation guidelines] for the project and [moderation queue]s. Chairs should be cognizant that a new group will require
111+
- An email account that can create Google Groups and add members external to
112+
your organization to a Google Group mailing list. **This might not be possible
113+
with your employer's email account**. You might need to use a personal email
114+
account.
115+
- At least 3 mailing list owners (leads), in addition to
116+
117+
- Familiarity with the [moderation guidelines] for the project and
118+
[moderation queue]s. Chairs should be cognizant that a new group will require
95119
an initial time investment moderation-wise as the group establishes itself.
96120

97121

98122
### Create the leads and members mailing lists
99123

100-
> **Note:** You will need follow these steps twice! Once for the leads mailing list, and again for the members mailing list.
124+
> **Note:** You will need follow these steps twice! Once for the leads mailing
125+
list, and again for the members mailing list.
101126

102-
1. Navigate to https://groups.google.com/forum/#!creategroup and fill out the **Enter group info** form as follows:
127+
1. Navigate to https://groups.google.com/forum/#!creategroup and fill out the
128+
**Enter group info** form as follows:
103129

104130
| Field | Leads ML value | Members ML value |
105131
| --- | --- | --- |
106-
| **Group name** | `kubernetes-sig-<foo>-leads` | `kubernetes-sig-<foo>` |
132+
| **Group name** | SIGs: `kubernetes-sig-<foo>-leads`<br>WGs: `kubernetes-wg-<foo>-leads` | SIGs: `kubernetes-sig-<foo>`<br>WGs: `kubernetes-wg-<foo>`<br>Subprojects: `kubernetes-<foo>` |
107133
| **Group email address** | Leave as-is | Leave as-is
108-
| **Group description** | Leads ML for Kubernetes SIG Foo | Members ML for Kubernetes SIG Foo |
134+
| **Group description** | Leads ML for Kubernetes [SIG/WG] Foo | Members ML for Kubernetes [SIG/WG/subproject] Foo |
109135

110-
Click **Next**.
136+
Click **Next**.
137+
111138
2. Fill out the the **Choose privacy settings** with these options:
112139

113140
| Field | Leads ML value | Members ML value |
@@ -124,13 +151,16 @@ an initial time investment moderation-wise as the group establishes itself.
124151

125152
| Field | Leads ML value | Members ML value |
126153
| --- | --- | --- |
127-
| **Group owners** | All SIG/WG leads and [email protected] | All SIG/WG leads and [email protected] |
154+
| **Group owners** | All SIG/WG leads and [email protected] | All SIG/WG/subproject leads and [email protected] |
128155

129-
> **Note:** You can add new owners to a mailing list at any time in the **People > Members** screen.
156+
> **Note:** You can add new owners to a mailing list at any time in the
157+
**People > Members** screen.
130158
131159
Leave all other fields as-is. Click **Next.**
132160

133-
4. Once the group is created, navigate to your group in the Google Groups UI and go to **Group settings** to continue setting up permissions. Set the following settings:
161+
4. Once the group is created, navigate to your group in the Google Groups UI and
162+
go to **Group settings** to continue setting up permissions. Set the following
163+
settings:
134164

135165
**Member Privacy**
136166

@@ -154,7 +184,7 @@ an initial time investment moderation-wise as the group establishes itself.
154184

155185
| Field | Leads ML value | Members ML value |
156186
| --- | --- | --- |
157-
| **Subject prefix** | `[k8s-sig-<foo>-leads]` | `[k8s-sig-<foo>]` |
187+
| **Subject prefix** | SIGs: `[k8s-sig-<foo>-leads]`<br>WGs: `[k8s-wg-<foo>-leads]` | SIGs: `[k8s-sig-<foo>]`<br>WGs: `[k8s-wg-<foo>]`<br>Subprojects: `[k8s-<foo>]` |
158188
| **Email footer** | Include the standard Groups footer | Include the standard Groups footer |
159189
| **Group email language** | English (or your group's default language) | English (or your group's default language) |
160190

@@ -166,42 +196,51 @@ an initial time investment moderation-wise as the group establishes itself.
166196
| **Who can adjust roles** | Group managers | Group managers
167197

168198
5. Click **Save changes**.
199+
Once your mailing list is created, it should also be added to the [sigs.yaml]
200+
file. For subprojects, it should be added like:
201+
```yaml
202+
- name: Foo
203+
contact:
204+
mailing_list: [link to Google Group]
205+
```
169206
170-
171-
172-
173-
174207
## Set up shared calendars and meeting with a mailing list
175208
176209
Once you've set up your SIG/WG mailing list, you'll need to:
177210
- Share a calendar with meeting invites on it with the mailing list
178211
- Share a meeting notes google doc with the mailing list
179212
180-
### Prerequisites
213+
### Prerequisites for sharing a calendar and meeting notes
181214
182-
- A member's google group.
215+
- A member's Google Group.
183216
- A shared calendar.
184-
> **Note:** Like with mailing lists, your organization's permissions might not let you share calendars with the correct permissions. You might need to use a personal email address.
217+
> **Note:** Like with mailing lists, your organization's permissions might not
218+
let you share calendars with the correct permissions. You might need to use a
219+
personal email address.
185220
186-
### Sharing the calendar with the google group
221+
### Sharing the calendar with the Google Group
187222
188223
You must share the meeting calendar with the following people:
189224
- All leads (individually)
190-
- The kubernetes-sig-foo-leads mailing list
225+
- The kubernetes-[sig-/wg-]foo-leads mailing list
191226
192-
- The kubernetes-sig-foo (members) mailing list
227+
- The kubernetes-[sig-/wg-]foo (members) mailing list
193228
194-
1. In Google Calendar, click on the calendar's **...** menu and select **Settings and sharing**.
229+
1. In Google Calendar, click on the calendar's **...** menu and select
230+
**Settings and sharing**.
195231
2. In **Access permissions**, check **Make available to public**.
196232
3. Under **Share with specific people, do the following:**
197-
- For each lead, [email protected], and [email protected]:
233+
- For each lead, [email protected], and
234+
198235
1. Add their email
199236
2. Give them the permission **Make changes and manage sharing**.
200-
- For [email protected], add them and give them the permission **See all event details**.
237+
- For [email protected], add them and give them the
238+
permission **See all event details**.
201239
202-
> **Note:** You need to add the member's mailing list as a guest to any meeting invites on the shared calendar for an invite to be sent to members of the group.
240+
> **Note:** You need to add the member's mailing list as a guest to any meeting
241+
invites on the shared calendar for an invite to be sent to members of the group.
203242
204-
## Sharing the meeting notes with the google group
243+
### Sharing the meeting notes with the Google Group
205244
206245
- Create and share your _"meeting notes"_ Google doc with the following
207246
permissions settings:
@@ -212,7 +251,7 @@ You must share the meeting calendar with the following people:
212251
document should be copied over to an account without the restriction and
213252
include the owner reference at the top of the document.
214253

215-
### Archive a mailing list
254+
## Archive a mailing list
216255

217256
To archive a mailing list, use the below procedure.
218257

@@ -249,4 +288,5 @@ To archive a mailing list, use the below procedure.
249288
[lock the thread immediately]: https://support.google.com/groups/answer/2466386?hl=en#
250289
[delete the post]: https://support.google.com/groups/answer/1046523?hl=en
251290
[these instructions]: https://support.google.com/groups/answer/2646833?hl=en&ref_topic=2458761#
252-
[groups help]: https://support.google.com/groups/answer/2466386?hl=en&ref_topic=2458761
291+
[groups help]: https://support.google.com/groups/answer/2466386?hl=en&ref_topic=2458761
292+
[sigs.yaml]: /sigs.yaml

0 commit comments

Comments
 (0)