Skip to content

Commit f5a978d

Browse files
authored
[Doc] Add communication guide (#3837)
* docs(COMMUNICATION): Add communication guide with info on slack, forum, and developer office hours link from README, CONTRIBUTING, DEVELOPER_GUIDE Signed-off-by: Josh Romero <rmerqg@amazon.com> --------- Signed-off-by: Josh Romero <rmerqg@amazon.com>
1 parent ca0bb8f commit f5a978d

5 files changed

+95
-1
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
167167
- [Doc] Update SECURITY.md with instructions for nested dependencies and backporting ([#3497](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3497))
168168
- [Doc] [Console] Fix/update documentation links in Dev Tools console ([#3724](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3724))
169169
- [Doc] Update DEVELOPER_GUIDE.md with added manual bootstrap timeout solution and max virtual memory error solution with docker ([#3764](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3764))
170+
- [Doc] Add COMMUNICATIONS.md with info about Slack, forum, office hours ([#3837](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3837))
170171
- [Doc] Add docker files and instructions for debugging Selenium functional tests ([#3747](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3747))
171172

172173
### 🛠 Maintenance

COMMUNICATIONS.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# OpenSearch Dashboards Communication
2+
3+
- [Overview](#overview)
4+
- [Slack](#slack)
5+
- [Forum](#forum)
6+
- [Developer Office Hours](#developer-office-hours)
7+
- [What it is](#what-it-is)
8+
- [When](#when)
9+
- [How to sign up](#how-to-sign-up)
10+
- [FAQ](#faq)
11+
12+
## Overview
13+
14+
The purpose of this document is to provide information regarding the communication channels for OpenSearch Dashboards. 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.
15+
16+
## Slack
17+
18+
The OpenSearch project has a public workspace on [Slack](https://opensearch.slack.com). See the [Getting Started guide]() for steps to register and setup the workspace.
19+
20+
Once registered, check out these channels for discussion of OpenSearch Dashboards topics:
21+
22+
- [#dashboards](https://opensearch.slack.com/archives/C01QENNTGUD)
23+
- [#dashboards-ux](https://opensearch.slack.com/archives/C05389T9LJC)
24+
25+
## Forum
26+
27+
Slack conversations are not searchable outside the workspace. For this reason we encourage using the [OpenSearch Dashboards category](https://forum.opensearch.org/c/opensearch-dashboards/57) of the forum for technical support discussions or summarizing findings for the rest of the community.
28+
29+
## Developer Office Hours
30+
31+
### What it is
32+
33+
A recurring 1-hour virtual meeting for community developers to chat with [OpenSearch Dashboards project maintainers](MAINTAINERS.md). Priority will be given to topics that are signed-up in advance, but ad-hoc discussions are welcome in any remaining time.
34+
35+
While we'll always prioritize asynchronous communication, sometimes a community call is the most effective and efficient venue to share information and knowledge. Some reasons to sign up:
36+
37+
1. Review a proposal or technical design for a new feature in OpenSearch Dashboards or an OpenSearch Dashboards plugin
38+
2. Learn more about how to build and extend OpenSearch Dashboards - which APIs, plugins, resources, and services are available to speed development
39+
3. Discuss OpenSearch Dashboard roadmap and technical initiatives
40+
41+
Signing up isn't required to attend - all OpenSearch Dashboards contributors or interested developers are welcome as participants.
42+
43+
Bring your ideas and projects early, while you still have time and flexibility to make significant changes.
44+
45+
### When
46+
47+
Every other Thursday, 10AM-11AM PT.
48+
49+
### How to sign up
50+
51+
There will be a forum post for each iteration of the meeting, with pre-defined slots. To sign-up, simply reply in the forum thread with the following template:
52+
53+
* Topic: [a brief description of what you'd like to discuss]
54+
* Requested by: [provide GitHub aliases of attendees]
55+
* GitHub issues or PRs: [before signing up, make sure to create an issue, whether in the OpenSearch Dashboards repository or your own plugin repository]
56+
* Time required [choose 15, 30, 45, or 60 minutes]
57+
* Requested maintainer: [optional; provide GitHub alias of any particular maintainer you’d like to attend]
58+
59+
### FAQ
60+
61+
#### Will the meetings be recorded?
62+
63+
Yes, we plan to record each office hours session and post to our YouTube channel so the information can be more easily shared and referenced.
64+
65+
#### Will all maintainers attend?
66+
67+
Generally no, but there will always be at least one maintainer. We'll review the sign-ups ahead of time to make sure the right subject-matter experts will attend, depending on the topics.
68+
69+
#### What happens if there are no sign-ups for a particular session?
70+
71+
The session will still occur, and the maintainers will present a brief knowledge-sharing session or demo. We'll also hold ad-hoc discussions, but the session may end early.
72+
73+
#### Is it first come first serve or do we get to decide which topics we discuss in a session?
74+
75+
For sign-ups, it’s first-come first served, until we decide we need another method.
76+
77+
#### Will there also be meeting notes? or is the recording the only available transcript?
78+
79+
No. But we’ll also post the chat transcript and any slides shared (see https://forum.opensearch.org/t/opensearch-community-meeting-2023-0131/11892/5 as example)
80+
81+
#### How can I cancel or reschedule?
82+
83+
Just leave another forum reply, as early as possible so other folks have the opportunity to sign-up for the same spot.

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
- [Contributing to OpenSearch](#contributing-to-opensearch-dashboards)
22
- [First Things First](#first-things-first)
33
- [Ways to Contribute](#ways-to-contribute)
4+
- [Join the Discussion](#join-the-discussion)
45
- [Bug Reports](#bug-reports)
56
- [Feature Requests](#feature-requests)
67
- [Documentation Changes](#documentation-changes)
@@ -19,6 +20,11 @@ OpenSearch is a community project that is built and maintained by people just li
1920
**Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin).
2021

2122
## Ways to Contribute
23+
24+
### Join the Discussion
25+
26+
See the [communication guide](COMMUNICATION.md)for information on how to join our slack workspace, forum, or developer office hours.
27+
2228
### Bug Reports
2329

2430
A bug is when software behaves in a way that you didn't expect and the developer didn't intend. To help us understand what's going on, we first want to make sure you're working from the latest version. Please make sure you're testing against the [latest version](https://github.com/opensearch-project/OpenSearch-Dashboards).

DEVELOPER_GUIDE.md

+4
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,10 @@ $ yarn start --run-examples
209209
- [Project testing guidelines](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/TESTING.md)
210210
- [Plugin conventions](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/CONVENTIONS.md#technical-conventions)
211211

212+
#### Join the discussion
213+
214+
See the [communication guide](COMMUNICATION.md)for information on how to join our slack workspace, forum, or developer office hours.
215+
212216
## Alternative development installations
213217

214218
Although the [getting started guide](#getting-started-guide) covers the recommended development environment setup, there are several alternatives worth being aware of.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Set up your [OpenSearch Dashboards development environment](ttps://github.com/op
2727
* [Project Website](https://opensearch.org/)
2828
* [Downloads](https://opensearch.org/downloads.html)
2929
* [Documentation](https://opensearch.org/docs/)
30-
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/)
30+
* Need help? See the [communication guide](COMMUNICATION.md) for various options
3131
* [Project Principles](https://opensearch.org/#principles)
3232
* [Developer Guide](DEVELOPER_GUIDE.md)
3333
* [Contributing to OpenSearch](CONTRIBUTING.md)

0 commit comments

Comments
 (0)