|
1 | | -# Mailing list and Github usage best practice |
2 | | - |
3 | | -The Kubernetes Mailing list or Google Groups functions as the primary means of |
4 | | -asynchronous communication for the project's |
5 | | -[Special Interest Groups (SIG)][sig-list] and [Working Groups (WG)][wg-list]. |
6 | | -That's why you may want to set your filters in your email account to attain a |
7 | | -good signal-to-noise ratio with regards to the mailing list messages and Github |
8 | | -notifications. All the steps below are basically for Gmail users. |
9 | | - |
10 | | -Note: Alternatively, we highly encourage people to use [Gubernator][gubernator] |
11 | | -and [improve][repo] it instead of setting these filters. |
12 | | - |
13 | | -Note: If you are looking to create and manage lists as a chair or other organizer, |
14 | | -check this mailing list [guideline][mailinglist-guidelines] doc. |
15 | | - |
16 | | -- [Example for setting filters to Kubernetes Mailing lists](#example-for-setting-filters-to-kubernetes-mailing-lists) |
17 | | -- [Examples for setting filters to Kubernetes Github notifications](#examples-for-setting-filters-to-kubernetes-github-notifications) |
18 | | - |
19 | | -## Example for setting filters to Kubernetes Mailing lists |
20 | | - |
21 | | -It depends on the SIG or/and WG you are involved in. |
22 | | -You can setup filters for your Gmail account to be able to categorize emails from |
23 | | -different mailing lists. |
24 | | -Create a filter following the procedure below: |
| 1 | +--- |
| 2 | +title: "Notification Management Best Practices" |
| 3 | +description: | |
| 4 | + A collection of tips, filters, and best practices for managing Mailing List |
| 5 | + and GitHub notifications. |
| 6 | +--- |
| 7 | + |
| 8 | +# Mailing list and GitHub notification best practice |
| 9 | + |
| 10 | +The Kubernetes Mailing list or Google Groups functions as the primary means of |
| 11 | +asynchronous communication for the project's [Special Interest Groups (SIG)] and |
| 12 | +[Working Groups (WG)]. That's why you may want to set your filters in |
| 13 | +your email account to attain a good signal-to-noise ratio with regards to the |
| 14 | +mailing list messages and GitHub notifications. All the steps below are for Gmail |
| 15 | +users, however similar filters can be made in other email clients. |
| 16 | + |
| 17 | +**Note:** Alternatively, we highly encourage people to use [Gubernator] to |
| 18 | +view and acknowledge their Pull Request review notifications. |
| 19 | + |
| 20 | +[Special Interest Groups (SIG)]: /sig-list.md#master-sig-list |
| 21 | +[Working Groups (WG)]: /sig-list.md#master-working-group-list |
| 22 | +[Gubernator]: https://gubernator.k8s.io/pr |
25 | 23 |
|
| 24 | + |
| 25 | +## Creating filters for Kubernetes Mailing lists |
| 26 | + |
| 27 | +It depends on the SIG or/and WG you are involved in. You can setup filters for |
| 28 | +your Gmail account to be able to categorize emails from different mailing lists. |
| 29 | + |
| 30 | + |
| 31 | +Create a filter following the procedure below: |
26 | 32 | - In your Gmail account click on **Settings**: |
27 | 33 | - **Filters and Blocked Addresses** -> Scroll down and click **create a new filter** |
28 | 34 | - In the **to** fields write the email of the SIG's Google Group. |
29 | 35 | - **Create filter** -> Check the box ** Apply the label** and create new |
30 | | -label by choosing **New label...** in the dropdown list. |
| 36 | + label by choosing **New label...** in the dropdown list. |
31 | 37 | - Click on the **Create filter**. |
32 | | -- You can also use filters directly for lists. |
33 | | - - Matches: list:" [email protected]" |
34 | | - - Do this: Apply label "lists/kubernetes-dev" |
35 | | - |
36 | | -## Examples for setting filters to Kubernetes Github notifications |
37 | | - |
38 | | -In order to not get spammed by Github notifications and to get all the |
39 | | -notifications in the right place, here is an example of filters to create/apply |
40 | | -on your Gmail account: |
41 | | - |
42 | | -- Stick a blue label on anything kubernetes-related: |
43 | | - - Matches: (kubernetes OR kubernetes-client OR kubernetes-sigs OR kubernetes-incubator |
44 | | -OR kubernetes-csi) |
45 | | - - Do this: Apply label "k8s", Mark it as important |
46 | | -- Archive your own actions (sending these is an option in Github's settings). |
47 | | -You can send them but also archive them, so whenever you need to see the history of |
48 | | -an issue you can: |
49 | | - |
50 | | - - Do this: Skip Inbox, Mark as read |
| 38 | +- Create filter directly for lists: |
| 39 | + - **Matches: ** list:" [email protected]" |
| 40 | + - **Do this:** Apply label "lists/kubernetes-dev" |
| 41 | + |
| 42 | + |
| 43 | +For more assistance on creating filters, see the Gmail help page on |
| 44 | +[Creating rules to filter your email]. |
| 45 | + |
| 46 | + |
| 47 | +## Creating filters for Kubernetes Github notifications |
| 48 | + |
| 49 | +These below suggested Gmail filters can help you organize and obtain better |
| 50 | +signal GitHub notification emails. |
| 51 | + |
| 52 | +Before you begin, you must know how to create filters in Gmail. For this |
| 53 | +procedure, see the Gmail help page on [Creating rules to filter your email]. |
| 54 | + |
| 55 | +- Apply a blue label on anything kubernetes-related: |
| 56 | + - **Matches:** (kubernetes OR kubernetes-client OR kubernetes-sigs OR |
| 57 | + kubernetes-csi) |
| 58 | + - **Do this:** Apply label "k8s", Mark it as important |
| 59 | +- Archive your own actions (sending these is an option in Github's settings). |
| 60 | + You can send them but also archive them, so whenever you need to see the history |
| 61 | + of an issue you can: |
| 62 | + - **Matches: ** to:( [email protected]) |
| 63 | + - **Do this:** Skip Inbox, Mark as read |
51 | 64 | - Skip bot comments: |
52 | | - - Matches: (from:( [email protected]) (from:(k8s-merge-robot) OR |
53 | | -from:(Kubernetes Prow Robot) OR from:(k8s-ci-robot))) |
54 | | - - Do this: Skip Inbox, Mark as read |
| 65 | + - **Matches: ** (from:( [email protected]) (from:(k8s-merge-robot) OR |
| 66 | + from:(Kubernetes Prow Robot) OR from:(k8s-ci-robot))) |
| 67 | + - **Do this:** Skip Inbox, Mark as read |
55 | 68 | - Skip push notifications: |
56 | | - |
57 | | - - Do this: Skip Inbox, Mark as read |
58 | | -- Red label on things assigned to you and/or things request to be reviewed: |
59 | | - |
60 | | - - Do this: Star it, Apply label "gh/assigned", Mark it as important |
61 | | - |
62 | | - - Do this: Star it, Apply label "gh/requested_review", Mark it as important |
63 | | -- Orange label on things you commented on: |
64 | | - |
65 | | - - Do this: Star it, Apply label "gh/commented" |
66 | | -- Yellow label on things you have been mentioned on: |
67 | | - |
68 | | - - Do this: Apply label "gh/mentioned" |
69 | | -- Grey label: |
70 | | - |
71 | | - - Do this: Apply label "gh/team_mention" |
72 | | - |
73 | | - - Do this: Star it, Apply label "gh/authored", Mark it as important |
| 69 | + - **Matches: ** to:( [email protected]) |
| 70 | + - **Do this:** Skip Inbox, Mark as read |
| 71 | +- Apply a red label on things assigned to you and/or things request to be reviewed: |
| 72 | + - **Matches: ** to:( [email protected]) |
| 73 | + - **Do this:** Star it, Apply label "gh/assigned", Mark it as important |
| 74 | + - **Matches: ** to:( [email protected]) |
| 75 | + - **Do this:** Star it, Apply label "gh/requested_review", Mark it as important |
| 76 | +- Apply an orange label on things you commented on: |
| 77 | + - **Matches: ** to:( [email protected]) |
| 78 | + - **Do this:** Star it, Apply label "gh/commented" |
| 79 | +- Apply a yellow label on things you have been mentioned on: |
| 80 | + - **Matches: ** to:( [email protected]) |
| 81 | + - **Do this:** Apply label "gh/mentioned" |
| 82 | +- Apply a grey label: |
| 83 | + - **Matches: ** to:( [email protected]) |
| 84 | + - **Do this:** Apply label "gh/team_mention" |
| 85 | + - **Matches: ** to:( [email protected]) |
| 86 | + - **Do this:** Star it, Apply label "gh/authored", Mark it as important |
74 | 87 | - Skip messages about issues that you are not participating in, but leave them unread: |
75 | | - |
76 | | - - Do this: Skip Inbox |
| 88 | + |
| 89 | + - **Do this:** Skip Inbox |
77 | 90 | - Categorize per repository: |
78 | | - - Matches: list:(community.kubernetes.github.com) |
79 | | - - Do this: Apply label "k8s/community" |
80 | | - |
81 | | -This [thread](https://groups.google.com/forum/#!topic/kubernetes-dev/5qU8irU7_tE/discussion) in kubernetes-dev google group |
82 | | -is also useful for setting up filters in Gmail. |
83 | | - |
84 | | -[sig-list]: /sig-list.md#master-sig-list |
85 | | -[wg-list]: /sig-list.md#master-working-group-list |
86 | | -[mailinglist-guidelines]: /communication/mailing-list-guidelines.md |
87 | | -[gubernator]: https://gubernator.k8s.io/pr |
88 | | -[repo]: https://git.k8s.io/test-infra/gubernator |
| 91 | + - **Matches:** list:(community.kubernetes.github.com) |
| 92 | + - **Do this:** Apply label "k8s/community" |
| 93 | + |
| 94 | +These suggestions come largely from an old [kubernetes-dev] mailing list [thread] |
| 95 | +on Gmail filters for Kubernetes. |
| 96 | + |
| 97 | +[kubernetes-dev]: https://groups.google.com/g/kubernetes-dev |
| 98 | +[thread]: https://groups.google.com/forum/#!topic/kubernetes-dev/5qU8irU7_tE/discussion |
| 99 | + |
| 100 | +<!-- shared links --> |
| 101 | +[Creating rules to filter your email]: https://support.google.com/mail/answer/6579?hl=en |
0 commit comments