Skip to content

Instantly share code, notes, and snippets.

@ajhalili2006
Forked from reetp/Readme.md
Last active July 6, 2020 10:36
Show Gist options
  • Save ajhalili2006/5f54b34f1fe6201a9dd617ab5f0f2d73 to your computer and use it in GitHub Desktop.
Save ajhalili2006/5f54b34f1fe6201a9dd617ab5f0f2d73 to your computer and use it in GitHub Desktop.
An one-file documentation on getting Support.

Rocket.Chat - Asking for help

For users with issues with our services, please do yourselves a few favours before asking for help.

How to ask for help

To pay or not to pay

If you think your issue is urgent, then you have two choices.

a) Pay for support - Pricing

Email: support@rocket.chat

b) Patiently wait for a volunteer to consider helping you.

You are entitled to exactly what you paid for

No more, and no less.

Please remember:

Abusing any community member will get you banned completely.

  • YOU are the one with the problem. You would not be here otherwise
  • Most people in the chat are volunteers who will try and help for free
  • Volunteers do this in their spare time and are not getting paid for this. Respect them
  • Just because it is urgent for you does mean that it is urgent for them
  • Your time might be valuable. Theirs is invaluable
  • They have jobs to do and mouths to feed. Don't waste their time
  • Answer their questions. They are not asking for fun but to try and understand
  • Being rude to them will not help you at all
  • Repeating your question 10 times in one channel will not help you.
  • Posting the same question in several channels will not help you
  • Do not DM anyone unless you know them, or they DM you first
  • Do not randomly @ people or @all hoping to get attention

Abuse of these things you will just get you muted, blocked or banned and you will not get any help

Don't open a bug yet

Do NOT open a new issue in github until you have read the rest of this document. Most 'issues' are configuration problems, not bugs.

Do NOT ask a question, wait for 30 seconds, and then decide you are way too important to wait around and your client is nagging and you'll open a bug to get it fixed faster. It will probably just get closed unless it is well documented and really is a bug.

If you ask in the channels or forums then devs or other community helpers will tell you if you really need to open an issue.

Frequently if there really IS a problem you won't be the first to experience it, so always check github carefully for duplicates. Use lots of different search terms and make sure you check closed Issues as well (see below)

Is it a feature request?

If Rocket works but doesn't do something the way you want it to then this is a feature request NOT a bug. Open a request in Feature Requests

RTFM

Have you read ALL the documentation? At least twice?

A lot of the answers can be found there. Read through slowly and carefully.

It is easy to miss the obvious because you think you know the answer you are just looking for confirmation of this , rather than reading to actually understand (and discovering you might just have been wrong)

Search

Have you looked through the bug reports? At least 2 different searches? Opened AND Closed bugs?

A lot of answers can be found there.

Check the various repos - Rocket itself, the mobile apps, electron etc.

Rocket.Chat server Rocket.Chat server feature requests React Native Mobile Client Electron desktop application Rocket.Chat documentation

When searching change the filter box to both open and closed issues like this:

is:issue is open

to

is:issue my search word

e.g.

is: issue theme

Try some variations - you won't hit the sweet spot first time usually. And the more often you do this the better you will get at learning what to search for and how. It is an art.

Still stuck?

Don't open an Issue yet.

The next step is to ask your well documented question in the forums or Rocket.Chat

It is impossible to diagnose something when you just say 'it's broken'. The helpers are not mind readers. They cannot see your screen or your your set-up. They have not watched you set this up, and the mistakes you made along the way. They are effectively blind. So you have got to describe things clearly and concisely.

Your problem may appear complex but it is often the basics that catch you out. It is hard to tell at first if a problem is simple or complex so please be patient if you get asked 'the stupid questions'. We are just trying to get a baseline and making sure you have done the basics, and trying to understand how you got to this position. It is extremely common for people to miss steps in their set-up.

Don't hide things away because you are embarrassed. They are most likely going to find out, so you might as well be honest. We have ALL made mistakes.

This is a really good guide on how to report issues clearly and (more importantly) how to get the attention of developers and helpers - the people who have the solutions to your issue.

http://www.catb.org/esr/faqs/smart-questions.html

This one is very relevant and it can waste a lot of time:

http://xyproblem.info/

Tell us about the problem you were originally trying to solve, not the problem that you are experiencing right now. Frequently the one you are experiencing now is the result of not understanding or being able to fix the original issue.

Remember, if you phoned the garage about your car and said 'it runs funny sometimes' what would they ask you? Make, model, age... etc.

This is no different.

Use this as a template to ask your question. Get all the right information. It will help if you then have to submit a real Issue.

https://github.com/RocketChat/Rocket.Chat/issues/new?template=bug_report.md

Server Set-up Information:

  • Version of Rocket.Chat Server:
  • Operating System:
  • Deployment Method:
  • Number of Running Instances:
  • DB Replicaset Oplog:
  • NodeJS Version:
  • MongoDB Version:

Some background will help, and will avoid XY issues. Is it a fresh install? Is it an upgraded install? Has it always been broken? When it did the issue start? Did you make any changes that could have caused it?

Make sure you post some BRIEF log snippets or use https://pastebin.com/

Don't block up the channel with ridiculously long messages.

If your problem relates to a connection to say a database, or LDAP, that might be on another server then check the logs for those as well.

Here is a great example of a good bug report:

RocketChat/Rocket.Chat#13069

Last, be patient. Answer the questions you are asked. They may appear odd, but they are probably for a good reason. Debugging is a logical process and you need to help establish the facts first.

Remember, you are the one with the problem. They can just go back to work or their wife and kids and ignore you.

A classic is:

I want to know how to do X

Why do you want to do X?

Because I do.

But X is not a very good thing to be doing.

But I want to.

Tell us why because there may be a different solution, even though it might not be the one you want to hear.

Shut up bozo. You know nothing (So why are you asking us then?? Confirmation bias...). Just tell me what I want to know

I can tell you that is not the correct solution and will cause you untold grief and in a few days you'll be back complaining your system is broken/hacked/otherwise shredded and you have thousands of users shouting at you.

And you'll probably starting asking with "HELP URGENT HELP REQUIRED NOW"


Remember it is you asking for help. It is you with the problem. So please don't bite the hand that feeds you.


Open an Issue

Got this far with no solution? If you haven't already been told to do so then open an Issue with all the right information in the right repo.

Please use the templates provided. Add all the relevant information.

Stick to facts, not opinions, assumptions or guesses.

Rocket.Chat server Rocket.Chat server feature requests React Native Mobile Client Electron desktop application Rocket.Chat documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment