summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com>2021-01-15 06:17:51 -0800
committerGitHub <noreply@github.com>2021-01-15 06:17:51 -0800
commit1d2f056f405d2c4938cfdd73ad22407ebd9eb293 (patch)
tree058207de588fe36e648e24e654b8ce263d70c3fa
parent0c9f572dbb72932ad2785d7b31588f2d58c26acb (diff)
parentce6f1e142be6190b37d80ce502868b32a59ac5bc (diff)
Merge pull request #5397 from mrbobbytables/comms
Update comms guidelines
-rw-r--r--communication/best-practices.md169
-rw-r--r--communication/calendar-guidelines.md7
-rw-r--r--communication/discuss-guidelines.md29
-rw-r--r--communication/mailing-list-guidelines.md19
-rw-r--r--communication/moderation.md78
-rw-r--r--communication/moderators.md37
-rw-r--r--communication/requesting-survey.md134
-rw-r--r--communication/slack-guidelines.md16
-rw-r--r--communication/website-guidelines.md7
-rw-r--r--communication/youtube/youtube-guidelines.md20
-rw-r--r--communication/zoom-guidelines.md22
11 files changed, 375 insertions, 163 deletions
diff --git a/communication/best-practices.md b/communication/best-practices.md
index 5bab35c1..3d1534e3 100644
--- a/communication/best-practices.md
+++ b/communication/best-practices.md
@@ -1,88 +1,101 @@
-# Mailing list and Github usage best practice
-
-The Kubernetes Mailing list or Google Groups functions as the primary means of
-asynchronous communication for the project's
-[Special Interest Groups (SIG)][sig-list] and [Working Groups (WG)][wg-list].
-That's why you may want to set your filters in your email account to attain a
-good signal-to-noise ratio with regards to the mailing list messages and Github
-notifications. All the steps below are basically for Gmail users.
-
-Note: Alternatively, we highly encourage people to use [Gubernator][gubernator]
-and [improve][repo] it instead of setting these filters.
-
-Note: If you are looking to create and manage lists as a chair or other organizer,
-check this mailing list [guideline][mailinglist-guidelines] doc.
-
-- [Example for setting filters to Kubernetes Mailing lists](#example-for-setting-filters-to-kubernetes-mailing-lists)
-- [Examples for setting filters to Kubernetes Github notifications](#examples-for-setting-filters-to-kubernetes-github-notifications)
-
-## Example for setting filters to Kubernetes Mailing lists
-
-It depends on the SIG or/and WG you are involved in.
-You can setup filters for your Gmail account to be able to categorize emails from
-different mailing lists.
-Create a filter following the procedure below:
+---
+title: "Notification Management Best Practices"
+description: |
+ A collection of tips, filters, and best practices for managing Mailing List
+ and GitHub notifications.
+---
+
+# Mailing list and GitHub notification best practice
+
+The Kubernetes Mailing list or Google Groups functions as the primary means of
+asynchronous communication for the project's [Special Interest Groups (SIG)] and
+[Working Groups (WG)]. That's why you may want to set your filters in
+your email account to attain a good signal-to-noise ratio with regards to the
+mailing list messages and GitHub notifications. All the steps below are for Gmail
+users, however similar filters can be made in other email clients.
+
+**Note:** Alternatively, we highly encourage people to use [Gubernator] to
+view and acknowledge their Pull Request review notifications.
+
+[Special Interest Groups (SIG)]: /sig-list.md#master-sig-list
+[Working Groups (WG)]: /sig-list.md#master-working-group-list
+[Gubernator]: https://gubernator.k8s.io/pr
+
+## Creating filters for Kubernetes Mailing lists
+
+It depends on the SIG or/and WG you are involved in. You can setup filters for
+your Gmail account to be able to categorize emails from different mailing lists.
+
+
+Create a filter following the procedure below:
- In your Gmail account click on **Settings**:
- **Filters and Blocked Addresses** -> Scroll down and click **create a new filter**
- In the **to** fields write the email of the SIG's Google Group.
- **Create filter** -> Check the box ** Apply the label** and create new
-label by choosing **New label...** in the dropdown list.
+ label by choosing **New label...** in the dropdown list.
- Click on the **Create filter**.
-- You can also use filters directly for lists.
- - Matches: list:"kubernetes-dev@googlegroups.com"
- - Do this: Apply label "lists/kubernetes-dev"
-
-## Examples for setting filters to Kubernetes Github notifications
-
-In order to not get spammed by Github notifications and to get all the
-notifications in the right place, here is an example of filters to create/apply
-on your Gmail account:
-
-- Stick a blue label on anything kubernetes-related:
- - Matches: (kubernetes OR kubernetes-client OR kubernetes-sigs OR kubernetes-incubator
-OR kubernetes-csi)
- - Do this: Apply label "k8s", Mark it as important
-- Archive your own actions (sending these is an option in Github's settings).
-You can send them but also archive them, so whenever you need to see the history of
-an issue you can:
- - Matches: to:(your_activity@noreply.github.com)
- - Do this: Skip Inbox, Mark as read
+- Create filter directly for lists:
+ - **Matches:** list:"kubernetes-dev@googlegroups.com"
+ - **Do this:** Apply label "lists/kubernetes-dev"
+
+
+For more assistance on creating filters, see the Gmail help page on
+[Creating rules to filter your email].
+
+
+## Creating filters for Kubernetes Github notifications
+
+These below suggested Gmail filters can help you organize and obtain better
+signal GitHub notification emails.
+
+Before you begin, you must know how to create filters in Gmail. For this
+procedure, see the Gmail help page on [Creating rules to filter your email].
+
+- Apply a blue label on anything kubernetes-related:
+ - **Matches:** (kubernetes OR kubernetes-client OR kubernetes-sigs OR
+ kubernetes-csi)
+ - **Do this:** Apply label "k8s", Mark it as important
+- Archive your own actions (sending these is an option in Github's settings).
+ You can send them but also archive them, so whenever you need to see the history
+ of an issue you can:
+ - **Matches:** to:(your_activity@noreply.github.com)
+ - **Do this:** Skip Inbox, Mark as read
- Skip bot comments:
- - Matches: (from:(notifications@github.com) (from:(k8s-merge-robot) OR
-from:(Kubernetes Prow Robot) OR from:(k8s-ci-robot)))
- - Do this: Skip Inbox, Mark as read
+ - **Matches:** (from:(notifications@github.com) (from:(k8s-merge-robot) OR
+ from:(Kubernetes Prow Robot) OR from:(k8s-ci-robot)))
+ - **Do this:** Skip Inbox, Mark as read
- Skip push notifications:
- - Matches: to:(push@noreply.github.com)
- - Do this: Skip Inbox, Mark as read
-- Red label on things assigned to you and/or things request to be reviewed:
- - Matches: to:(assign@noreply.github.com)
- - Do this: Star it, Apply label "gh/assigned", Mark it as important
- - Matches: to:(review_requested@noreply.github.com)
- - Do this: Star it, Apply label "gh/requested_review", Mark it as important
-- Orange label on things you commented on:
- - Matches: to:(comment@noreply.github.com)
- - Do this: Star it, Apply label "gh/commented"
-- Yellow label on things you have been mentioned on:
- - Matches: to:(mention@noreply.github.com)
- - Do this: Apply label "gh/mentioned"
-- Grey label:
- - Matches: to:(team_mention@noreply.github.com)
- - Do this: Apply label "gh/team_mention"
- - Matches: to:(author@noreply.github.com)
- - Do this: Star it, Apply label "gh/authored", Mark it as important
+ - **Matches:** to:(push@noreply.github.com)
+ - **Do this:** Skip Inbox, Mark as read
+- Apply a red label on things assigned to you and/or things request to be reviewed:
+ - **Matches:** to:(assign@noreply.github.com)
+ - **Do this:** Star it, Apply label "gh/assigned", Mark it as important
+ - **Matches:** to:(review_requested@noreply.github.com)
+ - **Do this:** Star it, Apply label "gh/requested_review", Mark it as important
+- Apply an orange label on things you commented on:
+ - **Matches:** to:(comment@noreply.github.com)
+ - **Do this:** Star it, Apply label "gh/commented"
+- Apply a yellow label on things you have been mentioned on:
+ - **Matches:** to:(mention@noreply.github.com)
+ - **Do this:** Apply label "gh/mentioned"
+- Apply a grey label:
+ - **Matches:** to:(team_mention@noreply.github.com)
+ - **Do this:** Apply label "gh/team_mention"
+ - **Matches:** to:(author@noreply.github.com)
+ - **Do this:** Star it, Apply label "gh/authored", Mark it as important
- Skip messages about issues that you are not participating in, but leave them unread:
- - Matches: from:(notifications@github.com) to:(subscribed@noreply.github.com)
- - Do this: Skip Inbox
+ - **Matches:** from:(notifications@github.com) to:(subscribed@noreply.github.com)
+ - **Do this:** Skip Inbox
- Categorize per repository:
- - Matches: list:(community.kubernetes.github.com)
- - Do this: Apply label "k8s/community"
-
-This [thread](https://groups.google.com/forum/#!topic/kubernetes-dev/5qU8irU7_tE/discussion) in kubernetes-dev google group
-is also useful for setting up filters in Gmail.
-
-[sig-list]: /sig-list.md#master-sig-list
-[wg-list]: /sig-list.md#master-working-group-list
-[mailinglist-guidelines]: /communication/mailing-list-guidelines.md
-[gubernator]: https://gubernator.k8s.io/pr
-[repo]: https://git.k8s.io/test-infra/gubernator
+ - **Matches:** list:(community.kubernetes.github.com)
+ - **Do this:** Apply label "k8s/community"
+
+These suggestions come largely from an old [kubernetes-dev] mailing list [thread]
+on Gmail filters for Kubernetes.
+
+[kubernetes-dev]: https://groups.google.com/g/kubernetes-dev
+[thread]: https://groups.google.com/forum/#!topic/kubernetes-dev/5qU8irU7_tE/discussion
+
+<!-- shared links -->
+[Creating rules to filter your email]: https://support.google.com/mail/answer/6579?hl=en
diff --git a/communication/calendar-guidelines.md b/communication/calendar-guidelines.md
index bc592742..3446fc77 100644
--- a/communication/calendar-guidelines.md
+++ b/communication/calendar-guidelines.md
@@ -1,3 +1,10 @@
+---
+title: "Calendar and Meeting Guidelines"
+description: |
+ Calendar and meeting guidelines, best practices, tips and troubleshooting
+ guidance.
+---
+
# Calendar Guidelines
Project meetings are a life line of the Kubernetes project. Consistent
diff --git a/communication/discuss-guidelines.md b/communication/discuss-guidelines.md
index 23b246ab..dded2ff6 100644
--- a/communication/discuss-guidelines.md
+++ b/communication/discuss-guidelines.md
@@ -1,5 +1,30 @@
+---
+title: "Discuss Forum Guidelines"
+description: |
+ Overview of Discourse, it's moderation capabilities and how they're applied
+ in the Kubernetes Forum, along with detailed instructions on requesting new
+ categories.
+---
+
+<!-- omit in toc -->
# Discuss guidelines
+
+- [Code of conduct](#code-of-conduct)
+- [Privacy Policy](#privacy-policy)
+- [Admins](#admins)
+- [General communication guidelines](#general-communication-guidelines)
+ - [PM (Private Message) conversations](#pm-private-message-conversations)
+ - [Escalating and/or reporting a problem](#escalating-andor-reporting-a-problem)
+- [Moderation](#moderation)
+ - [Moderator expectations and guidelines](#moderator-expectations-and-guidelines)
+ - [Other moderator responsibilities](#other-moderator-responsibilities)
+ - [Ingest queue](#ingest-queue)
+- [New category requests](#new-category-requests)
+ - [Requesting a general category](#requesting-a-general-category)
+ - [Requesting a SIG, WG, or sub-project category](#requesting-a-sig-wg-or-sub-project-category)
+ - [Requesting a regional category](#requesting-a-regional-category)
+
Discuss (discuss.kubernetes.io), is the Kubernetes community forum backed by
the [Discourse] discussion platform. It serves as the primary communication
platform for Kubernetes users; replacing the kubernetes-users mailing list in
@@ -10,7 +35,7 @@ Communication should be polite and respectful. Follow the general guideline of
_"be excellent to each other"_.
**Reference Links:**
-- [KEP 0007] - A community forum for Kubernetes
+- [A community forum for Kubernetes KEP]
- [Archive k-users] - kubernetes-users mailing list migrated to Discuss
@@ -176,7 +201,7 @@ list with the new region, the moderators and their timezone.
[Discourse]: https://discourse.org
-[KEP 0007]: https://github.com/kubernetes/enhancements/blob/master/keps/sig-contributor-experience/0007-20180403-community-forum.md
+[A community forum for Kubernetes KEP]: https://github.com/kubernetes/enhancements/tree/master/keps/sig-contributor-experience/0000-community-forum
[archive k-users]: https://github.com/kubernetes/community/issues/2492
[Kubernetes Code of Conduct]: /code-of-conduct.md
[Linux Foundation Privacy Policy]: https://www.linuxfoundation.org/privacy/
diff --git a/communication/mailing-list-guidelines.md b/communication/mailing-list-guidelines.md
index c2f739e3..2a05da92 100644
--- a/communication/mailing-list-guidelines.md
+++ b/communication/mailing-list-guidelines.md
@@ -1,3 +1,11 @@
+---
+title: "Mailing List Guidelines"
+description: |
+ Guidelines for Mailing list (Google Group) creation, sharing, archival and
+ moderation.
+---
+
+<!-- omit in toc -->
# Mailing list guidelines
The Kubernetes mailing list or Google Groups functions as the primary means of
@@ -5,16 +13,7 @@ asynchronous communication for the project's
[Special Interest Groups (SIG)][sig-list], [Working Groups (WG)][sig-list], and
large subprojects.
-### ATTENTION: SIG/WG/Subproject Mailing list owners
-
-If you are currently a moderator of a SIG, WG, or subproject mailing list,
-see the new policy requirements here:
-- [Mailing list annual review](#annual-permissions-review)
-- [Mailing list moderation queue](#new-user-posting-queue)
- - [Creating moderation queue](#create-moderation-queue)
-
-## Table of Contents
- [Code of conduct](#code-of-conduct)
- [Admins](#admins)
- [Mailing list owners](#mailing-list-owners)
@@ -30,6 +29,8 @@ see the new policy requirements here:
- [Sharing the calendar with the Google Group](#sharing-the-calendar-with-the-google-group)
- [Sharing the meeting notes with the Google Group](#sharing-the-meeting-notes-with-the-google-group)
- [Archive a mailing list](#archive-a-mailing-list)
+
+
## Code of conduct
The Kubernetes project adheres to the community [Code of Conduct] throughout all
diff --git a/communication/moderation.md b/communication/moderation.md
index 8d656daa..b1feb73b 100644
--- a/communication/moderation.md
+++ b/communication/moderation.md
@@ -1,3 +1,11 @@
+---
+title: "Moderation Rules and Responsibilities"
+description: |
+ Overview of community property moderator roles, responsibilities, selection,
+ and best practices.
+---
+
+<!-- omit in toc -->
# Moderation on Kubernetes Communications Channels
@@ -12,20 +20,21 @@ lists, YouTube, Zoom, and any property listed in the SIG Contributor Experience
---
-- [Moderation on Kubernetes Communications Channels](#moderation-on-kubernetes-communications-channels)
- - [Selection of Moderators](#selection-of-moderators)
- - [Moderators Pro Tempore](#moderators-pro-tempore)
- - [Rotation of Moderators](#rotation-of-moderators)
- - [Roles and Responsibilities](#roles-and-responsibilities)
- - [Violations](#violations)
- - [Escalation Procedures](#escalation-procedures)
- - [Platform Specific Guidelines](#platform-specific-guidelines)
- - [Discuss](#discuss)
- - [Mailing List](#mailing-list)
- - [Slack](#slack)
- - [YouTube](#youtube)
- - [Zoom](#zoom)
- - [References and Resources](#references-and-resources)
+
+- [Selection of Moderators](#selection-of-moderators)
+ - [Moderators Pro Tempore](#moderators-pro-tempore)
+- [Rotation of Moderators](#rotation-of-moderators)
+- [Roles and Responsibilities](#roles-and-responsibilities)
+- [Violations](#violations)
+- [Escalation Procedures](#escalation-procedures)
+- [Platform Specific Guidelines](#platform-specific-guidelines)
+ - [Discuss](#discuss)
+ - [Mailing List](#mailing-list)
+ - [Slack](#slack)
+ - [YouTube](#youtube)
+ - [Zoom](#zoom)
+ - [Process for Adding a Moderator](#process-for-adding-a-moderator)
+- [References and Resources](#references-and-resources)
---
@@ -64,8 +73,7 @@ The process for applying for moderatorship is as follows:
using to moderate.
- **[Open an issue][moderator request] against the kubernetes/community repo**
- Ensure your sponsors are @mentioned on the issue.
- - Complete every item on the checklist ([preview the current version of the
- template][moderator template])
+ - Complete every item on the checklist
- Make sure that the list of contributions included is representative of your
work on the project.
- Have your sponsoring reviewers reply confirmation of sponsorship: `+1` or
@@ -116,9 +124,12 @@ Moderators _MUST_:
- Abide by the documented tasks and actions required of moderators.
- Ensure that the Kubernetes [Code of Conduct] is in effect on all official
Kubernetes communication channels.
-- Make yourself generally available during working hours in your time zone for moderation.
- - This can be handled as a group so that there is enough coverage of people to allow for absences/travel.
- - Ensure you are on #slack-admins during work hours and notifications are set appropriately.
+- Make yourself generally available during working hours in your time zone for
+ moderation.
+ - This can be handled as a group so that there is enough coverage of people to
+ allow for absences/travel.
+ - Ensure you are on #slack-admins during work hours and notifications are set
+ appropriately.
- Become familiar with the [Kubernetes Community Values].
- Take care of spam as soon as possible, which may mean taking action by
removing a member from that resource.
@@ -173,10 +184,10 @@ procedures:
other primary moderators as soon as possible.
- If appropriate, the next level of people to contact are the OWNERS of the
subproject.
- - If appropriate, the next level of people to contact is the [Code of Conduct
- Committee].
- - If appropriate, the next level of people to contact is the [Steering
- Committee].
+ - If appropriate, the next level of people to contact is the
+ [Code of Conduct Committee].
+ - If appropriate, the next level of people to contact is the
+ [Steering Committee].
- Moderators will have access to a private document with contact information of
the appropriate people.
- Primary moderators will then execute an audit of the affected property:
@@ -227,12 +238,22 @@ This is the workflow for adding a moderator.
- Moderator applies by [filing an issue] in the kubernetes/community repo
- Moderator gets approval from 2 current moderators
- Add the person to their respective moderation tool:
- - Slack - Add them as a slack workspace admins (instructions pinned on #slack-admins-private): Invite them to #slack-admins-private, #slack-admins, #slack-log, #slack-reports and #slack-invites
+ - Slack - Add them as a slack workspace admins (instructions pinned on
+ #slack-admins-private): Invite them to #slack-admins-private, #slack-admins,
+ #slack-log, #slack-reports and #slack-invites
- Discuss - Change their permission to moderator
- - Kubernetes.io Google group - PR the person into the correct yaml file in kubernetes/k8s.io. (Note: This only applies to groups using @kubernetes.io, most other lists are still managed out of band)
- - Ensure they add that they are an admin in their profile page on whatever service they are administrating
-- Add them to the moderators mailing list by PRing them into this file, ensure you link to the person's moderator github application as part of the PR for reference: https://github.com/kubernetes/k8s.io/blob/master/groups/groups.yaml
-- Ensure person is enrolled for a future bias training course, this can either be provided by the project or their employer.
+ - Kubernetes.io Google group - PR the person into the correct yaml file in
+ kubernetes/k8s.io. (Note: This only applies to groups using @kubernetes.io,
+ most other lists are still managed out of band)
+ - Ensure they add that they are an admin in their profile page on whatever
+ service they are administrating
+- Add them to the moderators mailing list by PRing them into the
+ [moderators@kubernetes.io group] linking to the person's moderator github
+ application as part of the PR.
+- Ensure person is enrolled for a future bias training course, this can either
+ be provided by the project or their employer.
+
+[moderators@kubernetes.io group]: https://github.com/kubernetes/k8s.io/blob/master/groups/groups.yaml
## References and Resources
@@ -256,5 +277,4 @@ guidelines:
[Code of Conduct Committee]: /committee-code-of-conduct/README.md
[Steering Committee]: https://git.k8s.io/steering
[moderator request]: https://github.com/kubernetes/community/issues/new/choose
-[moderator template]: https://git.k8s.io/community/.github/ISSUE_TEMPLATE/moderator_application.md
[filing an issue]: https://github.com/kubernetes/community/issues/new/?assignees=&labels=area%2Fcommunity-management%2C+sig%2Fcontributor-experience&template=moderator_application.md&title=REQUEST%3A+New+moderator+for+%3Cyour-GH-handle%3E+of+%3Ck8s+property%3E
diff --git a/communication/moderators.md b/communication/moderators.md
index 03519065..35c448bb 100644
--- a/communication/moderators.md
+++ b/communication/moderators.md
@@ -1,9 +1,37 @@
+---
+title: "Moderator list"
+alias: [ "/mods", "/moderators" ]
+description: |
+ A list of the current communication property moderators and the timezones
+ they cover.
+---
+
+<!-- omit in toc -->
# Community Moderators
The following people are responsible for moderating/administrating Kubernetes
communication channels and their home time zone. See our
[moderation guidelines] for policies and recommendations.
+- [Mailing Lists](#mailing-lists)
+ - [kubernetes-dev](#kubernetes-dev)
+ - [Administrators](#administrators)
+ - [Primary Moderators](#primary-moderators)
+ - [Moderators Pro Tempore](#moderators-pro-tempore)
+- [GitHub](#github)
+- [Discuss](#discuss)
+ - [Administrators](#administrators-1)
+ - [Regional Category Moderators](#regional-category-moderators)
+- [YouTube Channel](#youtube-channel)
+ - [Owners](#owners)
+ - [Primary Moderators](#primary-moderators-1)
+ - [Moderators Pro Tempore](#moderators-pro-tempore-1)
+- [Slack](#slack)
+ - [Owner](#owner)
+ - [Moderators](#moderators)
+ - [Moderators Pro Tempore](#moderators-pro-tempore-2)
+- [Zoom](#zoom)
+
## Mailing Lists
### kubernetes-dev
@@ -20,14 +48,13 @@ Administrator seats: 3
#### Primary Moderators
-Primary moderators seats: 7
+Primary moderators seats: 6
| Name | Kubernetes Slack ID | Region | Timezone |
| ------------------- | ------------------- | -------- | ------------------------------------------------------- |
| Jorge Castro | @castrojo | Americas | [ET - Eastern Time (US East Coast)](https://time.is/ET) |
| Bob Killen | @mrbobbytables | Americas | [ET - Eastern Time (US East Coast)](https://time.is/ET) |
| Jaice Singer DuMars | @jdumars | Americas | [PT - Pacific Time (US West Coast)](https://time.is/PT) |
-| Louis Taylor | @kragniz | EMEA | [CET - Central European Time](https://time.is/CET) |
| Ihor Dvoretskyi | @ihor.dvoretskyi | EMEA | [EET - Eastern European Time](https://time.is/EET) |
| Nikhita Raghunath | @nikhita | APAC | [IST - Indian Standard Time](https://time.is/India) |
| _Open_ | _Open_ | | |
@@ -141,7 +168,7 @@ Moderators pro tempore seats: 3
## Slack
-#### Owner
+### Owner
Owners seats (non-admin role): 1
@@ -149,7 +176,7 @@ Owners seats (non-admin role): 1
| --------------- | ------------------- | -------- | ---------------------------------------------------- |
| Chris Aniszczyk | @caniszczyk | Americas | [CT - Central Time (US Central)](https://time.is/CT) |
-#### Moderators
+### Moderators
Moderators seats: 10
@@ -169,7 +196,7 @@ Moderators seats: 10
| Josh Berkus | @jberkus | Americas | [PT - Pacific Time (US West Coast)](https://time.is/PT) |
| Marky Jackson | @markyjackson | Americas | [PT - Pacific Time (US West Coast)](https://time.is/PT) |
-#### Moderators Pro Tempore
+### Moderators Pro Tempore
Moderators pro tempore seats: 10
diff --git a/communication/requesting-survey.md b/communication/requesting-survey.md
index 92d9a225..c17f093b 100644
--- a/communication/requesting-survey.md
+++ b/communication/requesting-survey.md
@@ -1,79 +1,153 @@
+---
+title: "Community Survey Requests"
+description: |
+ Outlines the process and workflow for requesting surveys on behalf of the
+ Kubernetes project.
+---
+
+
+<!-- omit in toc -->
# Requesting a Community Survey
+- [What's a Community Survey?](#whats-a-community-survey)
+- [Survey Request Process](#survey-request-process)
+ - [1. Determine Goals and Content of Survey](#1-determine-goals-and-content-of-survey)
+ - [2. Request Survey Review](#2-request-survey-review)
+ - [3. Request Survey Publication](#3-request-survey-publication)
+ - [4. Contributor Communications Promotion (optional)](#4-contributor-communications-promotion-optional)
+ - [5. Collect Survey Results](#5-collect-survey-results)
+ - [6. Publish Survey Results](#6-publish-survey-results)
+- [Tips and Notes Around Surveys](#tips-and-notes-around-surveys)
+
Let us help you make your survey a success.
-The Kubernetes project has access to the CNCF SurveyMonkey account for creating community surveys, and SIG-Contributor Experience includes people who can give advice on improving the quality of surveys, as well as promote them. As such, what follows is the process for requesting such a community survey, in order to maximize its reach and data quality.
+The Kubernetes project has access to the CNCF SurveyMonkey account for creating
+community surveys, and SIG-Contributor Experience includes people who can give
+advice on improving the quality of surveys, as well as promote them. As such,
+what follows is the process for requesting such a community survey, in order to
+maximize its reach and data quality.
## What's a Community Survey?
-Any survey requested by a Kubernetes SIG, WG, Team, or other standing Kubernetes community group (hereafter "Group") that targets some or all of the Kubernetes community and ecosystem is potentially a community survey. As some examples, this would include:
+Any survey requested by a Kubernetes SIG, WG, Team, or other standing Kubernetes
+community group (hereafter "Group") that targets some or all of the Kubernetes
+community and ecosystem is potentially a community survey. As some examples,
+this would include:
-* A survey by SIG-Cluster-Lifecycle on upgrade practices, targeted at Kubernetes users
-* A survey by SIG-ContribEx on contributor events, targeted at current contributors
-* A survey by the Release Engineering Team, targeted at vendors who repackage Kubernetes
+- A survey by SIG-Cluster-Lifecycle on upgrade practices, targeted at Kubernetes
+ users
+- A survey by SIG-ContribEx on contributor events, targeted at current contributors
+- A survey by the Release Engineering Team, targeted at vendors who repackage
+ Kubernetes
-Not included in community surveys are: surveys by specific vendors, surveys by other CNCF projects, surveys of target audiences outside the Kubernetes/CNCF community, or surveys that cannot be executed using SurveyMonkey and/or GoogleDocs.
+Not included in community surveys are: surveys by specific vendors, surveys by
+other CNCF projects, surveys of target audiences outside the Kubernetes/CNCF
+community, or surveys that cannot be executed using SurveyMonkey and/or
+Google Docs.
-If the survey you want to do is a community survey, then then next thing is to submit a request.
+If the survey you want to do is a community survey, then then next thing is to
+submit a request.
## Survey Request Process
### 1. Determine Goals and Content of Survey
-The first step needs to happen in your community Group. You need to determine:
+The first step needs to happen in your community Group. You need to determine:
1. Why you want to do a survey
2. Who you would like to answer it
3. What specific questions you want to ask
-Ideally, answer those questions in that order; first decide what your goals are, next which audiences you're targeting, and finally compose the individual questions.
+Ideally, answer those questions in that order; first decide what your goals are,
+next which audiences you're targeting, and finally compose the individual questions.
-Your survey will also need a preface which explains to the audience what the survey is for, who will get to see its raw results, and where compiled data from it will be published.
+Your survey will also need a preface which explains to the audience what the
+survey is for, who will get to see its raw results, and where compiled data
+from it will be published.
### 2. Request Survey Review
-Put your draft survey questions in a Google Doc, HackMD page, PR against one of your Group repos, or other format that supports comments by reviewers. Then open an [issue](https://github.com/kubernetes/community/issues) against the community repo using the **Survey Request** template.
+Put your draft survey questions in a Google Doc, HackMD page, PR against one of
+your Group repos, or other format that supports comments by reviewers. Then open
+an [issue] against the community repo using the **Survey Request** template.
-Members of SIG-ContribEx will then offer feedback on improving your survey, in the following areas:
+Members of SIG-ContribEx will then offer feedback on improving your survey, in
+the following areas:
-* Are the questions and options clear and unambiguous?
-* Are there obvious missing options to some questions?
-* Is the preface clear and complete?
-* Does the survey comply with the Kubernetes CoC and privacy practices?
+- Are the questions and options clear and unambiguous?
+- Are there obvious missing options to some questions?
+- Is the preface clear and complete?
+- Does the survey comply with the Kubernetes CoC and privacy practices?
Once you feel like the survey is as good as it's likely to be, we can publish it.
+[issue]: https://github.com/kubernetes/community/issues
+
### 3. Request Survey Publication
-By default, we use a SurveyMonkey account funded by the CNCF to publish surveys. This is because SurveyMonkey offers a fairly rich set of survey options, and more importantly is accessible in China. We can also publish surveys using the Kubernetes Google Drive account, if surveying Chinese developers or contributors is not a consideration. GDrive makes sharing the survey results easier.
+By default, we use a SurveyMonkey account funded by the CNCF to publish surveys.
+This is because SurveyMonkey offers a fairly rich set of survey options, and more
+importantly is accessible in China. We can also publish surveys using the
+Kubernetes Google Drive account, if surveying Chinese developers or contributors
+is not a consideration. GDrive makes sharing the survey results easier.
-In either case, it will take a few days for a ContribEx volunteer to copy the questions and options into the survey tool, and then it can be ready to announce on your schedule. Just comment on the issue giving your requested publication schedule, and mark it LGTM.
+In either case, it will take a few days for a ContribEx volunteer to copy the
+questions and options into the survey tool, and then it can be ready to announce
+on your schedule. Just comment on the issue giving your requested publication
+schedule, and mark it LGTM.
### 4. Contributor Communications Promotion (optional)
-If you want your survey to reach a large number of contributors, developers, or users, then the Contributor Marketing subproject can help. Use the [contributor comms issue template](https://github.com/kubernetes/community/issues/new/choose) to request help from that group. They will ask you some questions about promoting the survey and assist you in getting the word out, via the Kubernetes social medial accounts, mailing lists, and blog, depending on the target audience and scope.
+If you want your survey to reach a large number of contributors, developers, or
+users, then the Contributor Marketing subproject can help. Use the
+[contributor comms issue template] to request help from that group. They will
+ask you some questions about promoting the survey and assist you in getting the
+word out, via the Kubernetes social medial accounts, mailing lists, and blog,
+depending on the target audience and scope.
+
+[contributor comms issue template]: https://github.com/kubernetes/community/issues/new/choose
### 5. Collect Survey Results
-Your survey can be open anywhere from a few days to a few months, depending on your needs. In addition to any efforts Contributor-Comms may be making on your behalf, during this period your group should make sure to remind folks several times that the survey is open.
+Your survey can be open anywhere from a few days to a few months, depending on
+your needs. In addition to any efforts Contributor-Comms may be making on your
+behalf, during this period your group should make sure to remind folks several
+times that the survey is open.
-On request (via the Github issue or Slack messages) ContribEx volunteers can supply intermediate information, such as the number of surveys completed or the current results data.
+On request (via the Github issue or Slack messages) ContribEx volunteers can
+supply intermediate information, such as the number of surveys completed or the
+current results data.
### 6. Publish Survey Results
-When the survey is complete, the designated recipients for the raw data will receive a data dump in the form of a spreadsheet or CSV file, accompanied by copies of the simple graphs created by the survey system. As this data may contain personally identifying information, the recipients are required to be a small group who will treat the data with care.
+When the survey is complete, the designated recipients for the raw data will
+receive a data dump in the form of a spreadsheet or CSV file, accompanied by
+copies of the simple graphs created by the survey system. As this data may
+contain personally identifying information, the recipients are required to be a
+small group who will treat the data with care.
-Depending on the availability of some ContribEx members, you may also be able to get more advanced visualizations and/or data analysis assistance. This would be primarily correlating the answers to two or more questions, and providing graphs or charts for those correlations. Request this in your issue and we'll follow-up to help figure out exactly what you need.
+Depending on the availability of some ContribEx members, you may also be able to
+get more advanced visualizations and/or data analysis assistance. This would be
+primarily correlating the answers to two or more questions, and providing graphs
+or charts for those correlations. Request this in your issue and we'll follow-up
+to help figure out exactly what you need.
## Tips and Notes Around Surveys
-Please note that we are subject to the GDPR and other privacy regulations. As such, your survey will need to explain who will have access to the data and what it's for, and you need to adhere to those restrictions. Among other things, this means that you can never share raw survey data on a public mailing list or or GitHub repo (summary data that contains no personal information should be fine).
+Please note that we are subject to the GDPR and other privacy regulations. As
+such, your survey will need to explain who will have access to the data and what
+it's for, and you need to adhere to those restrictions. Among other things, this
+means that you can never share raw survey data on a public mailing list or or
+GitHub repo (summary data that contains no personal information should be fine).
Some additional tips for creating good surveys:
-* Have goals: the overall survey, and each question, should be expected to provide useful data for your SIG. If you can't figure out what you'd do with the response to a question, don't include that question.
-* Ask more, simpler questions rather than fewer, complex ones.
-* At the same time, try to produce the shortest survey that will actually give you the data you need.
-* Remember to include "Don't Know" or "Not Applicable" options.
-* Use "Other" options with care, as they tend to generate a lot of garbage input.
-* Don't survey too often; survey fatigue will set in an you won't get responses.
+- Have goals: the overall survey, and each question, should be expected to provide
+ useful data for your SIG. If you can't figure out what you'd do with the
+ response to a question, don't include that question.
+- Ask more, simpler questions rather than fewer, complex ones.
+- At the same time, try to produce the shortest survey that will actually give
+ you the data you need.
+- Remember to include "Don't Know" or "Not Applicable" options.
+- Use "Other" options with care, as they tend to generate a lot of garbage input.
+- Don't survey too often; survey fatigue will set in an you won't get responses.
diff --git a/communication/slack-guidelines.md b/communication/slack-guidelines.md
index 872c5a22..333964c4 100644
--- a/communication/slack-guidelines.md
+++ b/communication/slack-guidelines.md
@@ -1,3 +1,11 @@
+---
+title: "Slack Guidelines"
+description: |
+ The policies, procedures, and escalation mechanisms for the Slack platform,
+ such as requesting channels, tokens, and how to report inappropriate content.
+---
+
+<!-- omit in toc -->
# Slack Guidelines
Slack serves as the main communication platform for the Kubernetes community
@@ -15,15 +23,17 @@ video recording or in another public space. Please be courteous to others.
- [DM (Direct Message) Conversations](#dm-direct-message-conversations)
- [Specific Channel Rules](#specific-channel-rules)
- [Escalating and/or Reporting a Problem](#escalating-andor-reporting-a-problem)
+- [Should you have a channel on the Kubernetes Slack?](#should-you-have-a-channel-on-the-kubernetes-slack)
- [Requesting a Channel](#requesting-a-channel)
- [Delegating Channel Ownership](#delegating-channel-ownership)
- [Requesting a User Group](#requesting-a-user-group)
- [Requesting a Bot, Token, or Webhook](#requesting-a-bot-token-or-webhook)
- [Moderation](#moderation)
- - [Admin Expectations and Guidelines]()
- - [Sending Messages to the Channel]()
+ - [Admin Expectations and Guidelines](#admin-expectations-and-guidelines)
+ - [Sending Messages to the Channel](#sending-messages-to-the-channel)
- [Processing Slack Requests](#processing-slack-requests)
- [Processing Channel Requests](#processing-channel-requests)
+ - [Processing User Group Requests](#processing-user-group-requests)
- [Processing Bot, Token, or Webhook Requests](#processing-bot-token-or-webhook-requests)
- [Inactivating Accounts](#inactivating-accounts)
@@ -113,7 +123,7 @@ and describe the situation.
## Should you have a channel on the Kubernetes Slack?
The primary purpose of the Kubernetes slack is for the coordination of the
-Kubernentes project. However it is useful for developers and users to have a
+Kubernetes project. However it is useful for developers and users to have a
strong ecosystem of channels for related things. Here are some guidelines for
determining if you should request a channel:
diff --git a/communication/website-guidelines.md b/communication/website-guidelines.md
index b430b0c8..9c18ba1f 100644
--- a/communication/website-guidelines.md
+++ b/communication/website-guidelines.md
@@ -1,3 +1,10 @@
+---
+title: "Kubernetes.io Website Content Guidelines"
+description: |
+ List of the policies and groups responsible for different portions of the
+ Kubernetes website (https://kubernetes.io)
+---
+
# Website guidelines
## General content
diff --git a/communication/youtube/youtube-guidelines.md b/communication/youtube/youtube-guidelines.md
index c1a8ac3d..d620b1f5 100644
--- a/communication/youtube/youtube-guidelines.md
+++ b/communication/youtube/youtube-guidelines.md
@@ -1,3 +1,9 @@
+---
+title: "YouTube Guidelines"
+description: |
+ Overview of community YouTube practices and admin responsibilities.
+---
+
<!-- omit in toc -->
# YouTube Channel Guidelines
@@ -24,7 +30,7 @@ project, and includes all communication mediums.
## Admins
-- Check the [centralized list of administrators][admins] for contact information.
+- Check the [centralized list of administrators] for contact information.
- To contact the admin group in Slack, ping `@youtube-admins` in the `#sig-contribex`
Slack channel.
@@ -210,13 +216,13 @@ detailed information about streaming, see our [Streaming Config]
[Kubernetes YouTube Channel]: https://www.youtube.com/channel/UCZ2bu0qutTOM0tHYa_jkIwg
[collaboration]: https://support.google.com/youtube/answer/6109639
[loosen the permissions in your YouTube settings]: https://support.google.com/a/answer/6212415
-[SIG Contributor Experience]: https://git.kubernetes.io/community/sig-contributor-experience
-[centralized list of administrators]: ./moderators.md
-[YouTube admins]: ./moderators.md#YouTube-Channel
+[SIG Contributor Experience]: /sig-contributor-experience
+[centralized list of administrators]: /communication/moderators.md
+[YouTube admins]: /communication/moderators.md#YouTube-Channel
[trim]: https://support.google.com/youtube/answer/9057455?hl=en
[edit]: https://support.google.com/youtube/topic/9257530?hl=en&ref_topic=9257610
[Community Meeting]: /events/community-meeting.md
[Office Hours]: /events/office-hours.md
-[Meet our Contributors]: /mentoring/meet-our-contributors.md
-[Streaming Config]: ./youtube/streaming-config.md
-[Subprojects]: ./governance.md#subprojects \ No newline at end of file
+[Meet our Contributors]: /mentoring/programs/meet-our-contributors.md
+[Streaming Config]: ./streaming-config.md
+[Subprojects]: /governance.md#subprojects
diff --git a/communication/zoom-guidelines.md b/communication/zoom-guidelines.md
index d2767d2e..103a424c 100644
--- a/communication/zoom-guidelines.md
+++ b/communication/zoom-guidelines.md
@@ -1,3 +1,10 @@
+---
+title: "Zoom Guidelines"
+description: |
+ Policies, procedures and best practices for managing Zoom.
+---
+
+<!-- omit in toc -->
# Zoom guidelines
Zoom is the main video communication platform for Kubernetes.
@@ -14,6 +21,21 @@ Check the main [moderation] page for more information on other tools and general
moderation guidelines.
+- [Code of conduct](#code-of-conduct)
+- [Zoom license management](#zoom-license-management)
+ - [Obtaining a Zoom license](#obtaining-a-zoom-license)
+- [Setting up your meeting and moderation](#setting-up-your-meeting-and-moderation)
+ - [Moderation](#moderation)
+ - [Related moderation documentation](#related-moderation-documentation)
+ - [Escalating and/Reporting a Problem](#escalating-andreporting-a-problem)
+- [Meeting recordings](#meeting-recordings)
+- [Screen sharing guidelines and recommendations](#screen-sharing-guidelines-and-recommendations)
+- [Audio/Video quality recommendations](#audiovideo-quality-recommendations)
+ - [Recommended hardware to have](#recommended-hardware-to-have)
+ - [Hardware we don't recommend](#hardware-we-dont-recommend)
+ - [Pro-tips](#pro-tips)
+
+
## Code of conduct
The Kubernetes project adheres to the [Kubernetes Code of Conduct] throughout all