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.

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

Conversation

nknize
Copy link

@nknize nknize commented May 19, 2022

Adds new COMMUNICATIONS.md file describing the OpenSearch Project communications
policy and guidelines. First commit includes policy and guidelines for upcoming
slack workspace.

closes opensearch-project/.github#63

@nknize nknize added documentation Improvements or additions to documentation enhancement New feature or request labels May 19, 2022
@nknize nknize changed the title [Policy & Guildelines] COMMUNICATIONS.md and Public Slack [PROPOSAL] COMMUNICATIONS.md and Public Slack May 19, 2022
COMMUNICATIONS.md Outdated Show resolved Hide resolved
_Join Us_

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

Choose a reason for hiding this comment

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

So, I could understand requiring maintainers to use 2FA for access to GH and making commits. And while I wholeheartedly endorse 2FA everywhere, this feels like friction and we're appealing to authority (security) to justify the friction. While I'd love everyone to be perfectly secure, I am not sure the juice is worth the squeeze. At a minimum, we should be looking for whether this is enough friction that folks don't continue with the sign up process.

Copy link
Author

@nknize nknize May 19, 2022

Choose a reason for hiding this comment

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

This is a good point. The 2FA intent was to minimize Griefers / trolls. Maybe enabling it is premature at this point since we're just starting to build a vibrant community? I'm certainly not opposed starting w/o 2FA and enabling if slack bombing becomes a problem. Curious what others think.

Choose a reason for hiding this comment

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

I don't think of it as minimizing malicious folk causing pain by trolling, I see it as stopping malicious folk impersonating others if they're only relying on a weak password.

Copy link
Member

Choose a reason for hiding this comment

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

Wholeheartedly agree with 2FA on both the intent of minimizing trolls as well as a step to hopefully stop anyone from maliciously impersonating someone else. In a perfect scenario, we would be able to have people sign up with their GitHub accounts to truly identify who's who between the different area. (something I'm likely going to implement on the forum as an option)

COMMUNICATIONS.md Outdated Show resolved Hide resolved
COMMUNICATIONS.md Outdated Show resolved Hide resolved
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
Copy link

Choose a reason for hiding this comment

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

I'd encourage you to start with just #random and #general. Bifurcating where the community interacts prematurely impedes progress IMO. Wait until things are so busy that you need, and then slowly add channels as existing channels grow too busy and people complain.

Copy link
Author

Choose a reason for hiding this comment

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

We have pretty large activity on several OpenSearch repositories including a lot of dashboard communication which is abstracting the back-end from OpenSearch to accommodate other data providers. This was the idea behind separating channels for OpenSearch and Dashboards but not getting so crazy that we have a channel for every repository. On day 0 we're most certainly going to have a mix mash of discussions on #general with the existing opensearch and dashboard maintainers that I'm afraid will lead to back channeling to avoid noise.

Would a good compromise be to start with something smaller like #general, #core, #dashboards, #build, and a private #maintainers channel to discuss candidate maintainers?

Choose a reason for hiding this comment

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

+1 to you both. Hesitate to plan your community, let it be organic, however if your community has already been organic in A.N.Other location, then mimicking the core of that makes sense.

Copy link
Member

Choose a reason for hiding this comment

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

From a community standpoint, when starting out I would recommend the approach that less is more. Before I came over to the project - people would add a new category for every different plugin, etc - we now have 30+ categories on the forum, and people typically use about 5 of them. (and now I have a massive cleanup project to make it more functional)

Copy link
Author

Choose a reason for hiding this comment

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

Removing #maintainers and #project-build for now. We can add the build channel for buildbot failure notices later, and we can add a private #maintainers channel for new nominations later.

Choose a reason for hiding this comment

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

What about an #announcements channel that is expected to be low traffic, for major announcements such as new releases or significant deprecations or other important milestones? Given Slack's limitation of only one write-limited channel, this is one channel that needs to be set up out of the gate as an autosubscribe channel so as to avoid the need to ask people to subscribe to it in the future.

Copy link
Author

Choose a reason for hiding this comment

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

I like the announcements channel idea. I added it here.

COMMUNICATIONS.md Outdated Show resolved Hide resolved
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Overall good, made a bunch of comments.

COMMUNICATIONS.md Outdated Show resolved Hide resolved
COMMUNICATIONS.md Outdated Show resolved Hide resolved
COMMUNICATIONS.md Outdated Show resolved Hide resolved
COMMUNICATIONS.md Outdated Show resolved Hide resolved
COMMUNICATIONS.md Outdated Show resolved Hide resolved

* 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. No
Copy link
Member

Choose a reason for hiding this comment

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

I would say "We kindly ask you to use your real name."

We can never enforce this, so I wouldn't bother.

Copy link
Author

Choose a reason for hiding this comment

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

Yeah I think this one was causing confusion so I'm going to remove it altogether. Slack administration settings allow configuring the workspace to use Full Name as the display name instead of a preferred shorter "Display Name". It's true this doesn't prevent someone from putting a bogus name in the Full Name but this is what was meant by "no anonymous display names are allowed." I don't think there's a problem using preferred shortened display names and if it becomes a problem we can discuss it then.

Copy link
Member

Choose a reason for hiding this comment

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

We could also simply make the recommendation for people to use the same name they're already using on the forum or on GitHub. (also makes it easier to link people up between sites, which would be a good thing)

COMMUNICATIONS.md Outdated Show resolved Hide resolved
COMMUNICATIONS.md Outdated Show resolved Hide resolved
search among other community members.
* Use 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.
Copy link
Member

Choose a reason for hiding this comment

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

I feel like this is weird. Use whatever you want. Generally I don't love recommendations of what "not" to do, which is "don't use slack for technical support discussions".

Should this doc have a section on forums and their purpose as part of this PR?

Copy link
Author

Choose a reason for hiding this comment

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

Should this doc have a section on forums and their purpose as part of this PR?

I don't think so; that can be addressed in a separate PR.

Generally I don't love recommendations of what "not" to do, which is "don't use slack for technical support discussions".

I agree with this; the one wrinkle here is that the slack conversations are not searchable outside of the slack workspace. So if someone uses slack for technical support it will not be discoverable by the rest of the community. We can encourage folks to use the forum but if that's not documented somewher (like this "tips" section) it risks never being followed (just like forgetting to use slack threads to avoid the channel noise).

For now I reworded to explicitly mention this tip and encourage using the forum instead of making it sound like a policy.

Copy link
Member

Choose a reason for hiding this comment

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

The community will likely see the forum recommendation as a good thing - when given direction of where / what to use, most will appreciate it.

COMMUNICATIONS.md Outdated Show resolved Hide resolved
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

This LGTM!

Could you please remove the auto-line-wrap at 80, none of the other markdown files in this repo have that and it doesn't matter to GitHub nor will anyone read these in a terminal because they are markdown, not text.

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

This needs a refresh/update/status of public slack, and discuss moving this into .github repo.

dblock
dblock previously requested changes Mar 16, 2023
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Let's revive this and move it to .github.

COMMUNICATIONS.md Outdated Show resolved Hide resolved
Copy link

@wbeckler wbeckler left a comment

Choose a reason for hiding this comment

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

Should there be a section explaining who/how new channels get created?

nknize added 4 commits March 27, 2023 14:50
Adds new COMMUNICATIONS.md file describing the OpenSearch Project communications
policy and guidelines. First commit includes policy and guidelines for upcoming
public slack channel.

Signed-off-by: Nicholas Walter Knize <[email protected]>
Signed-off-by: Nicholas Walter Knize <[email protected]>
Signed-off-by: Nicholas Walter Knize <[email protected]>
@nknize nknize force-pushed the policy/communications branch from 47e26c9 to fddde57 Compare March 27, 2023 19:54
@nknize
Copy link
Author

nknize commented Mar 27, 2023

This is just about ready to go. Maybe we time box to end of week? I can move it to .github after we agree and merge here. I don't want to close this and fragment the ongoing conversation history.

@nknize
Copy link
Author

nknize commented Mar 27, 2023

Should there be a section explaining who/how new channels get created?

I'm not sure we need that level of managing. I suspect people are going to create channels ad-hoc for side discussions based on rapidly moving features, and that's a good thing.

Signed-off-by: Nicholas Walter Knize <[email protected]>
@nknize nknize requested review from dblock, ke4qqq, wbeckler and hyandell and removed request for ke4qqq March 29, 2023 14:03
@nknize nknize requested review from krisfreedain and ke4qqq and removed request for krisfreedain and ke4qqq March 29, 2023 14:04
@nknize nknize dismissed dblock’s stale review March 29, 2023 14:05

Keeping the PR here to retain history. We can move the doc to the correct repo after merge.

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Looks good. Open a PR in .github and close this?

@nknize
Copy link
Author

nknize commented Mar 31, 2023

Thanks all!! I'm closing this PR and moving it to opensearch-project/.github#153. It will merge on approval.

@nknize nknize closed this Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[PROPOSAL] Maintainers and admins communication channel
6 participants