From 2e391e0265dd5d569662eb9d538fdfccabc15fe0 Mon Sep 17 00:00:00 2001 From: Kris Freedain Date: Fri, 9 Aug 2024 11:55:51 -0700 Subject: [PATCH 1/3] Move COMMUNICATIONS file to community repo Signed-off-by: Kris Freedain --- COMMUNICATIONS.md | 54 ----------------------------------------------- 1 file changed, 54 deletions(-) delete mode 100644 COMMUNICATIONS.md diff --git a/COMMUNICATIONS.md b/COMMUNICATIONS.md deleted file mode 100644 index 0617056ed1d..00000000000 --- a/COMMUNICATIONS.md +++ /dev/null @@ -1,54 +0,0 @@ -# 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_ - - * Visit the [slack landing page](https://opensearch.org/slack.html) on OpenSearch.org for information on registering your account. 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): - - * **#admin-requests** - slack related feature requests and questions for the administration team. - * **#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. From dc6ff804216e545462426e9edbdeaee059c37335 Mon Sep 17 00:00:00 2001 From: Kris Freedain Date: Tue, 13 Aug 2024 15:25:42 -0700 Subject: [PATCH 2/3] Updates to README, profile, & ONBOARDING files Signed-off-by: Kris Freedain --- ONBOARDING.md | 7 +++++-- README.md | 2 ++ profile/README.md | 7 +++++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/ONBOARDING.md b/ONBOARDING.md index 0294dfabc71..5e305e71cc2 100644 --- a/ONBOARDING.md +++ b/ONBOARDING.md @@ -81,8 +81,11 @@ To create issues, leave comments, or submit pull requests, you'll need a GitHub 4. Recommended - Do (8 min) [Configure 2-factor authentication](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) 5. Optional - Read (5 min) If you're new to using GitHub or git, we recommend reviewing “[Using GitHub's tools and processes](https://docs.github.com/en/get-started/onboarding/getting-started-with-your-github-account#part-2-using-githubs-tools-and-processes)” -### OpenSearch forum account +### OpenSearch forum & Slack accounts -There are multiple ways to [connect with the OpenSearch community](https://opensearch.org/connect.html), but [the forum](https://forum.opensearch.org/) is the best place to start +There are multiple ways to [connect with the OpenSearch community](https://opensearch.org/connect.html), [the forum](https://forum.opensearch.org/) and [Slack](https://www.opensearch.org/slack.html) are the best places to start - **Do (2 min)** [create an OpenSearch forum](https://forum.opensearch.org/) account +- **Do (2 min)** [create an OpenSearch Slack](https://www.opensearch.org/slack.html) account + +Refer to the ['COMMUNICATIONS'](https://github.com/opensearch-project/community/blob/main/COMMUNICATIONS.md) file for additional information diff --git a/README.md b/README.md index f92f0e1879f..01bfec736cb 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ * [Downloads](https://opensearch.org/downloads.html) * [Documentation](https://opensearch.org/docs/latest/) * Need help? Try [Forums](https://forum.opensearch.org/) +* Talk to other developers? [Slack](https://opensearch.org/slack.html) +* [Communications](https://github.com/opensearch-project/community/blob/main/COMMUNICATIONS.md) * [Project Principles](https://opensearch.org/about.html#principles-for-development) * [Contributing to OpenSearch](CONTRIBUTING.md) * [Onboarding Guide](ONBOARDING.md) diff --git a/profile/README.md b/profile/README.md index c6925d27dad..dc697f54ecd 100644 --- a/profile/README.md +++ b/profile/README.md @@ -7,7 +7,7 @@ OpenSearch is a community-driven, Apache 2.0-licensed open source search and ana We are built 🧱 by the community for the community. If you would like to contribute there are many ways: - We have [a step-by-step onboarding guide](../ONBOARDING.md) to help you get oriented and prepared to contribute. -- 👀 Check out a project's `CONTRIBUTING.md` file to learn how to contribute. +- 👀 Check out a project's [`CONTRIBUTING.md`](../CONTRIBUTING.md) file to learn how to contribute. - [Blogs](https://github.com/opensearch-project/project-website) and [Documentation Updates](https://github.com/opensearch-project/documentation-website)! - Finally, make sure to try [OpenSearch](https://opensearch.org/docs/latest/opensearch/install/docker/) 🔎, [OpenSearch Dashboards](https://playground.opensearch.org/auth/anonymous) 🖥, and our Plugins/Client Libraries 📚 and leave feedback! @@ -16,9 +16,12 @@ We are built 🧱 by the community for the community. If you would like to contr There are several places where our community meets make sure to check them out! - 📝 [Forum](https://forum.opensearch.org/) +- 💬 [Slack](https://opensearch.org/slack.html) +- 🗣️ [User Groups & Triage meetings](https://www.meetup.com/pro/opensearchproject/) - ▶️ [YouTube](https://www.youtube.com/c/OpenSearchProject) -- 🐤 [Twitter](https://twitter.com/OpenSearchProj) - 🧑‍💼 [LinkedIn](https://www.linkedin.com/company/opensearch-project/) +- 🐘 [Mastodon](https://fosstodon.org/@OpenSearchProject) +- 🐤 [Twitter](https://twitter.com/OpenSearchProj) ---- From 3353b0ee898c4c65f6625e2017fc4a9add5ee345 Mon Sep 17 00:00:00 2001 From: Kris Freedain Date: Wed, 14 Aug 2024 10:22:20 -0700 Subject: [PATCH 3/3] edits to ONBOARDING Signed-off-by: Kris Freedain --- ONBOARDING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ONBOARDING.md b/ONBOARDING.md index 5e305e71cc2..60b1cc128a2 100644 --- a/ONBOARDING.md +++ b/ONBOARDING.md @@ -8,7 +8,7 @@ - [Resources and links](#resources-and-links) - [Set up accounts and access](#set-up-accounts-and-access) - [GitHub account](#github-account) - - [OpenSearch forum account](#opensearch-forum-account) + - [OpenSearch forum and Slack accounts](#opensearch-forum-and-slack-accounts) # Getting started as an OpenSearch contributor @@ -81,11 +81,11 @@ To create issues, leave comments, or submit pull requests, you'll need a GitHub 4. Recommended - Do (8 min) [Configure 2-factor authentication](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) 5. Optional - Read (5 min) If you're new to using GitHub or git, we recommend reviewing “[Using GitHub's tools and processes](https://docs.github.com/en/get-started/onboarding/getting-started-with-your-github-account#part-2-using-githubs-tools-and-processes)” -### OpenSearch forum & Slack accounts +### OpenSearch forum and Slack accounts -There are multiple ways to [connect with the OpenSearch community](https://opensearch.org/connect.html), [the forum](https://forum.opensearch.org/) and [Slack](https://www.opensearch.org/slack.html) are the best places to start +There are multiple ways to [connect with the OpenSearch community](https://opensearch.org/connect.html), [the forum](https://forum.opensearch.org/) and [Slack](https://www.opensearch.org/slack.html) are the best places to start. - **Do (2 min)** [create an OpenSearch forum](https://forum.opensearch.org/) account - **Do (2 min)** [create an OpenSearch Slack](https://www.opensearch.org/slack.html) account -Refer to the ['COMMUNICATIONS'](https://github.com/opensearch-project/community/blob/main/COMMUNICATIONS.md) file for additional information +Refer to the ['COMMUNICATIONS'](https://github.com/opensearch-project/community/blob/main/COMMUNICATIONS.md) file for additional information.