Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PROPOSAL] COMMUNICATIONS.md and Public Slack #46

Closed
wants to merge 5 commits into from
Closed

[PROPOSAL] COMMUNICATIONS.md and Public Slack #46

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f93f876
[Policy & Guildelines] COMMUNICATIONS.md and Public Slack
nknize May 19, 2022
b5b6289
Update from PR feedback 1
nknize May 19, 2022
125b565
PR updates round 2
nknize May 24, 2022
fddde57
Fix typos, remove unnecessary channels, add announcements channel
nknize Mar 27, 2023
2d4a369
unwrap lines
nknize Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions COMMUNICATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# OpenSearch Project Communication

- [Overview](#overview)
- [Slack](#slack)
- [Getting Started](#getting-started)
- [Workspace Channels](#workspace-channels)
- [Tips](#tips)

## Overview

The purpose of this document is to provide information regarding the communication channels for the OpenSearch Project. All communication is subject to the [OpenSearch Code of Conduct](CODE_OF_CONDUCT.md). Please see [CONTRIBUTING](CONTRIBUTING.md) if you're interested in contributing to the project.

## Slack

OpenSearch has a workspace on [Slack](https://opensearch.slack.com) to provide open communication channels for anyone interested in OpenSearch.

The following guidelines include a Getting Started for steps to register and setup the workspace along with tips for using the workspace. Please read through these guidelines carefully and thoroughly.

### Getting Started

_Join Workspace_

* Register your account at https://opensearch.slack.com. You will be required to enroll in two-factor authentication to ensure the best possible security of your account.

_Update Profile_

* You may add your interests or keywords in the “What I do” section of your profile along with your Title and Company/Organization. This helps participants network and connect with each other by common interests.
* Feel free to update your profile photo to something unique to you. All profile photos are subject to the [OpenSearch Code of Conduct](CODE_OF_CONDUCT.md) policies.
* Optionally share your pronouns by adding them to the end of your Full Name in your profile. This way other participants will be able to see them and be respectful to your communication preferences. Please also be respectful of other participants’ pronouns.

### Workspace Channels

After you join OpenSearch workspace you will be automatically added to the following channels:

* **#announcements** - Read only channel for overall project announcements. This may include critical security issues, releases, milestones or general information related to the OpenSearch Project community.
* **#general** - a channel for asking general questions. Based on the question or discussion users will mostly likely be directed to more specific channels based on the topics of interest.
* **#random** - consider this the water cooler in a face to face workspace. Feel free to introduce yourself to the community, share what you’re working on, or what you’re excited about learning with OpenSearch.

There are dedicated channels for the following (note that participants might be directed to more specific channels based on the nature of the discussion):

* **#dev** - primary channel for development questions. This is a good place to start for participants interested in OpenSearch development but are not sure which channels to join.
* **#core** - primary channel for core OpenSearch. General questions and discussions about the core can be asked here.
* **#dashboards** - primary channel for Dashboards. General questions and discussions about dashboards can be asked here.
* **#infra** - primary channel for infra. General discussions, questions, or infra requests can be posted here.

### Tips

* Try to keep communications in the open - not only does this facilitate better sharing of information but back channeled discussions are not retained for search among other community members.
* Slack conversations are not searchable outside the workspace. For this reason we encourage using the [OpenSearch Discussion Forum](https://forum.opensearch.org) for technical support discussions or, at least, open a summary discussion on the forum so useful findings can be shared with the rest of the community.
* Keep discussions organized - use threads to respond to comments inline instead of posting to the entire channel.
* Expect asynchronous response time - do not assume immediate response time, or possibly any response at all. This is a community driven communication tool with participants in different time zones. The workspace should not be treated as a formal support or training tool.
* Protecting IP and legally protected information is your responsibility, this is a public forum. Don’t presume anything said here will remain private.
* **DO NOT** post CVEs or Security issues publicly. See [SECURITY](SECURITY.md) for guidelines on handling security issues.