Slack Best Practices

Slack Best Practices

The Open edX Community uses Slack for real-time communication. This is good for coordinating meetings with working groups or discussing with another community member how to split up a work item. For general questions, though, we encourage you to use the forums (Forums (Discourse) ). Slack's history is not as searchable as Discourse's history, and Slack history disappears after 6 months. Asking a question in Discourse will benefit the community more than asking in Slack.

The #general channel doesn't get a lot of eyes on it because Slack doesn't allow you to share this channel with Slack Connect. See “Use the right channel” below to find an appropriate channel for your topic.

 

The Open edX community has a Slack workspace for live community chat.  You can join by requesting an automatic invitation.

All interactions in the Open edX community, including on Slack, are covered by the Open edX Community Code of Conduct.


Slack works best when everyone uses it well.  Here are some guidelines for how to get the most out of Slack.

Use the right channel

The Slack workspace is divided into different channels for different topics.  There are dozens of channels.  It's important to choose the right one.  #general is the default channel, but it doesn't get a lot of eyes on it because Slack doesn't allow you to share this channel with Slack Connect. Some of the common channels:

  • #wg-*: All working groups have a channel that starts with #wg- such as #wg-translations, #wg-frontend, #wg-design, #wg-data (including the Aspects Analytics team), and more.

  • #dev: working on changing Open edX code.

  • #ops: running an Open edX installation.

For technical help, please first search for your question on http://discuss.openedx.org and make a new post if you don’t find a solution. From there you may post your Discuss post into Slack. Please ensure to capture all solutions on your Discuss post.

Slack history is only retained for 3 months. The discussion forums retain history forever, so you’ll be helping the whole community by doing this.

If you aren't sure what channel is best, ask in #general, and you might hear about a new channel you hadn't discovered yet.

Please only ask in one channel at a time.  If you don't get an answer after a while (say 6 hours), you can try a different channel.  Posting in more than one channel at once just distracts more people.

Keep discussions public

Slack is a public place, where everyone can talk and see what people are talking about.  Direct messages might be appropriate if you have something private to discuss.  Direct messages shouldn't be used to get the attention of someone you think can help.  Everyone is busy, and everyone wants to help more.  Ask in a public channel.

If someone asks you for help in a direct message, you should point them to an appropriate public channel, and then help them there if you want.  It isn't impolite to ask that discussions be public.  The Open edX community is built on sharing, and sharing our help is important.  We have limited resources.  Help should be public so that others can learn, or help.  Even months later, public discussions can be found by searching Slack.  Direct messages are locked away.  Avoid them.

Use Threads

In public channels, it can be hard to have a long conversation.  It's easy to feel like you are cluttering the channel with a discussion that most people don't want to see.  Slack's Thread feature is the best way to keep the discussion public, but out of everyone's way.  A thread is a regular discussion, but off to the side, so it's out of the main flow of the channel.

To start or respond to a thread, use the speech bubble tool that appears at the right when you hover over a message:

Choose an appropriate level of detail

If you need help with a technical problem, you'll need to provide a number of details.  Try to be specific about what you've tried, and what you are seeing.  "It didn't work" doesn't tell helpers enough to fix the problem.

Often, you'll need to provide bulky information like log files or terminal sessions.  It's best to put these in a Gist (Discover gists ) so they won't clutter the discussion.  If you have something on a terminal screen you want to share, please copy the text from the terminal and put it in a Gist as text.  Screenshots are harder to read, and can't be searched.

Update your profile

The more people know about you, the more likely you are to connect well.  Slack lets you include your full name, a photo, and an affiliation.  Add them so that people will see that you are also a person, just like them!