Writerside Help

Writerside Slack

The JetBrains Writerside Slack workspace aims to be an inclusive space committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof). For this to be the case, it is vital that we all follow a basic set of guidelines and most importantly, adhere to the code of conduct.

As such, please make sure you read this code of conduct and basic usage guidelines. This is not your regular license agreement that you should scroll through and agree blindly. It is here for a reason and also contains practical information.

How to behave

  • Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.

  • Exercise consideration, respect, and empathy in your speech and actions. Remember, we have all been through different stages of learning when adopting technologies.

  • Refrain from demeaning, discriminatory, or harassing behavior and speech.

  • Disagreements on things are fine, argumentative behavior or trolling are not.

How not to behave

  • Do not perform threats of violence or use violent language directed against another person.

  • Do not make jokes of sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory nature, or use language of this nature.

  • Do not post or display sexually explicit or violent material.

  • Do not post or threaten to post other people's personally identifying information ("doxing").

  • Do not make personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.

  • Do not engage in sexual attention. This includes sexualized comments or jokes and sexual advances.

  • Do not advocate for, or encourage, any of the above behavior.

How to report issues

If someone is acting inappropriately or violating this code of conduct in any shape or form, and they are not receptive to your feedback, or you prefer not to confront them, please get in touch with one of the administrators. The main administrators are:

  • Anna Gasparyan @anna.gasparyan

  • Alexandra Maximova @alexandra.maximova

Basic usage guidelines

The influx of messages per day and the numerous channels can lead to a lot of noise and little value in the long run. If we all follow a set of guidelines, it can help make things more useful and bearable for everyone.

  • Remember, this is a Slack workspace for JetBrains Writerside. If you have generic questions about some technology that may or may not be used with JetBrains Writerside, it may be better to use another resource, such as StackOverflow.

  • For bug reports, we recommend submitting an issue in YouTrack. Questions about using JetBrains Writerside and its configuration are welcome both in Slack and YouTrack. You can ask and share whatever bothers you, and we will see if something can be done about it.

  • Find the right channel to ask your question. There are channels for pretty much every topic. For a list of several primary channels, see Common channels.

  • When you ask a question, be patient. Do not repeat it. Or at least not immediately.

  • Use English whenever you ask or answer a question.

  • Do not ping or mention someone directly to get your questions answered, especially project owners, whether the project is JetBrains Writerside or other, unless they specifically indicate that you can.

  • Don't split messages into multiple ones. Ask it all in a single message.

  • Use code blocks. Don't paste code as plain text: wrap it with backticks. Single backticks for `inline code` and triple backticks for:

    ``` multiline code blocks ```

    If the code you want to paste is long, use snippets available from the plus icon + menu next to the message field. Only the first few lines will be displayed to all users, and people interested in the code can expand your code to look into details.

  • While it is polite to say “Hi” or “I have a question” before asking something, it does not scale and leads to noise. You can greet everyone in the same message you ask the question.

  • Using threads is not required, but do take into account that it does allow people to more easily follow conversations, especially those jumping in late.

  • Use reactions to show gratitude as opposed to a message. It reduces the noise and gets the message across.

  • Do not use reactions to tell people they are in the wrong place or are asking the wrong question. If they are in the wrong channel, point them to the right one. If their question is badly worded, help them correct it. Have empathy.

  • Take into account cultural differences. As they say, what the British say is not what the British mean. Remember this both as the receiver and producer of messages.

  • Do not create integrations with Slack. Given the workspace is running on a free tier, the number is limited, and thus it will not be approved.

  • @channel, @here, and other forms of notifications are disabled, even if you own a channel (unfortunately, Slack does not allow fine-grained permissions).

  • Use the #general channel if you're unsure about something.

Resolving Issues

We want to keep our Slack conversations friendly and lively. However, in cases where someone does not follow our recommendations, or where we deem a reported issue to be in contradiction to this code of conduct, we reserve the rights to take action and remove such an individual or their comments from our Slack workspace.

Common channels

#general

Everything related to Writerside, such as feedback, questions, feature requests.

#writerside-announcements

Product news, announcements, release notes, and related discussions.

#help-needed

How to set up and start using Writerside. If you are new to our product, it is better to ask your questions here than in the #general channel.

This code of conduct is distributed under a Creative Commons Attribution-ShareAlike license. Portions of the text are derived from the Citizen Code of Conduct.

Last modified: 16 May 2024