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

Jump to bottom

[Doc] Add communication guide #3837

Merged
merged 4 commits into from
May 3, 2023
Merged

[Doc] Add communication guide #3837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f03c67
docs(COMMUNICATION): Add communication guide
joshuarrrr Apr 12, 2023
7396612
Fix bad link and grammar
joshuarrrr Apr 13, 2023
524a9a6
add changelog
joshuarrrr Apr 13, 2023
e2ca28d
Merge branch 'main' into docs/add-office-hours
joshuarrrr Apr 25, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- [Doc] Update SECURITY.md with instructions for nested dependencies and backporting ([#3497](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3497))
- [Doc] [Console] Fix/update documentation links in Dev Tools console ([#3724](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3724))
- [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))
- [Doc] Add COMMUNICATIONS.md with info about Slack, forum, office hours ([#3837](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3837))
- [Doc] Add docker files and instructions for debugging Selenium functional tests ([#3747](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3747))

### 🛠 Maintenance
Expand Down
83 changes: 83 additions & 0 deletions COMMUNICATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# OpenSearch Dashboards Communication

- [Overview](#overview)
- [Slack](#slack)
- [Forum](#forum)
- [Developer Office Hours](#developer-office-hours)
- [What it is](#what-it-is)
- [When](#when)
- [How to sign up](#how-to-sign-up)
- [FAQ](#faq)

## Overview

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.

## Slack

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.

Once registered, check out these channels for discussion of OpenSearch Dashboards topics:

- [#dashboards](https://opensearch.slack.com/archives/C01QENNTGUD)
- [#dashboards-ux](https://opensearch.slack.com/archives/C05389T9LJC)

## Forum

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.

## Developer Office Hours

### What it is

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.

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:

1. Review a proposal or technical design for a new feature in OpenSearch Dashboards or an OpenSearch Dashboards plugin
2. Learn more about how to build and extend OpenSearch Dashboards - which APIs, plugins, resources, and services are available to speed development
3. Discuss OpenSearch Dashboard roadmap and technical initiatives

Signing up isn't required to attend - all OpenSearch Dashboards contributors or interested developers are welcome as participants.

Bring your ideas and projects early, while you still have time and flexibility to make significant changes.

### When

Every other Thursday, 10AM-11AM PT.

### How to sign up
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: A link to the forum here would be useful. This can just be a link to the Dashboard channel there for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'll add it once we have the forum posts. Some of this stuff is a little circular 😁


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:

* Topic: [a brief description of what you'd like to discuss]
* Requested by: [provide GitHub aliases of attendees]
* GitHub issues or PRs: [before signing up, make sure to create an issue, whether in the OpenSearch Dashboards repository or your own plugin repository]
* Time required [choose 15, 30, 45, or 60 minutes]
* Requested maintainer: [optional; provide GitHub alias of any particular maintainer you’d like to attend]

### FAQ

#### Will the meetings be recorded?

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.

#### Will all maintainers attend?

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.

#### What happens if there are no sign-ups for a particular session?

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.

#### Is it first come first serve or do we get to decide which topics we discuss in a session?

For sign-ups, it’s first-come first served, until we decide we need another method.

#### Will there also be meeting notes? or is the recording the only available transcript?

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)

#### How can I cancel or reschedule?

Just leave another forum reply, as early as possible so other folks have the opportunity to sign-up for the same spot.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
- [Contributing to OpenSearch](#contributing-to-opensearch-dashboards)
- [First Things First](#first-things-first)
- [Ways to Contribute](#ways-to-contribute)
- [Join the Discussion](#join-the-discussion)
- [Bug Reports](#bug-reports)
- [Feature Requests](#feature-requests)
- [Documentation Changes](#documentation-changes)
Expand All @@ -19,6 +20,11 @@ OpenSearch is a community project that is built and maintained by people just li
**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).

## Ways to Contribute

### Join the Discussion

See the [communication guide](COMMUNICATION.md)for information on how to join our slack workspace, forum, or developer office hours.

### Bug Reports

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).
Expand Down
4 changes: 4 additions & 0 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,10 @@ $ yarn start --run-examples
- [Project testing guidelines](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/TESTING.md)
- [Plugin conventions](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/CONVENTIONS.md#technical-conventions)

#### Join the discussion

See the [communication guide](COMMUNICATION.md)for information on how to join our slack workspace, forum, or developer office hours.

## Alternative development installations

Although the [getting started guide](#getting-started-guide) covers the recommended development environment setup, there are several alternatives worth being aware of.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Feel free to take a look at what the community has been up to, and then head ove
* [Project Website](https://opensearch.org/)
* [Downloads](https://opensearch.org/downloads.html)
* [Documentation](https://opensearch.org/docs/)
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/)
* Need help? See the [communication guide](COMMUNICATION.md) for various options
* [Project Principles](https://opensearch.org/#principles)
* [Developer Guide](DEVELOPER_GUIDE.md)
* [Contributing to OpenSearch](CONTRIBUTING.md)
Expand Down