getting-help.rst 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. Getting Help
  2. ############
  3. Having a problem with Elgg? The best way to get help is to ask at the `Community Site`_. This site is community supported by a large group of volunteers. Here are a few tips to help you get the help you need.
  4. .. _Community Site: https://community.elgg.org/
  5. .. contents:: Contents
  6. :local:
  7. :depth: 1
  8. Getting help
  9. ============
  10. Don't be a `Help Vampire`_
  11. --------------------------
  12. We were all newbies at one time, but we can all learn. Not showing that you are making attempts to learn on your own or do your own research is off putting for those helping. Also, very generic questions like "How do I build a forum?" are almost impossible to answer.
  13. .. _Help Vampire: http://slash7.com/2006/12/22/vampires/
  14. Search first
  15. ------------
  16. Be sure to search the documentation (this site), the `Community Site`_, and Google before asking a question. New users to Elgg frequently have the same questions, so please search. People are less inclined to reply to a post that has been answered many other times or that can be answered easily by Googling.
  17. Ask once
  18. --------
  19. Posting the same questions in multiple places makes it hard to answer you. Ask your question in one place only. Duplicate questions may be moderated.
  20. Include Elgg Version
  21. --------------------
  22. Different versions of Elgg have different features (and different bugs). Including the version of Elgg that you are using will help those helping you.
  23. Have a reasonable profile
  24. -------------------------
  25. Profiles that look like spam or have silly names will often be ignored. Joviality is fine, but people are more likely to help Michael than 1337elggHax0r.
  26. Post in the appropriate forum
  27. -----------------------------
  28. Check to make sure you're posting in the right forum. If you have a question about creating a plugin, don't post to the Elgg Feedback forum. If you need help installing Elgg, post to Technical Support instead of the Theming group.
  29. Use a descriptive topic title
  30. -----------------------------
  31. Good topic titles concisely describe your problem or question. Bad topic titles are vague, contain all capital letters, and excessive punctuation.
  32. Good title: "White screen after upgrading to 1.7.4."
  33. Bad title: "URGENT!!!!! site broke ;-( losing money help!!!!!!!!!!!"
  34. Be detailed
  35. -----------
  36. Include as many details about your problem as possible. If you have a live site, include a link. Be forthcoming if community members might ask for more information. We can't help you if you won't give any details!
  37. Keep it public
  38. --------------
  39. This is a public forum for the good of the Elgg project. Keep posts public. There's no reason for anyone to ask you to send a private message or email. Likewise, there's no reason to ask anyone to send a private email to you. Post in the public.
  40. Guidelines
  41. ==========
  42. In addition to the `site-wide Terms and Policies`_, following these guidelines keeps our community site useful and safe for everyone.
  43. .. _site-wide Terms and Policies: http://community.elgg.org/terms/
  44. Content
  45. -------
  46. All content must be safe for work: PG in the US and UK. If your Elgg site has adult content and you have been asked to post a link, please mark it NSFW (Not Safe For Work) so people know.
  47. Excessive swearing in any language will not be tolerated.
  48. Mood
  49. ----
  50. Working with technical problems can be frustrating. Please keep the community site free of frustration. If you're feeling anxious, take a step away and do something else. Threatening or attacking community members, core developers, or plugin developers will not help solve your problem and will likely get you banned.
  51. Advertising
  52. -----------
  53. Advertising is not allowed. Posts with any sort of advertising will be moderated.
  54. Asking for money / Offering to pay
  55. ----------------------------------
  56. Don't ask for money on the community site. Likewise, don't offer to pay for answers. If you are looking for custom development, post to the Professional Services group. Posts asking for money or recommending a commercial plugin may be moderated.
  57. Links
  58. -----
  59. If you're having a problem with a live site, please provide a link to it.
  60. That said, the community site is not a back linking service or SEO tool. Excessive linking will be moderated and your account may be banned.
  61. Signatures
  62. ----------
  63. There's a reason Elgg doesn't have an option for signatures: they cause clutter and distract from the conversation. Users are discouraged from using signatures on the community site, and signatures with links or advertising will be removed.
  64. Bumping, +1, me too
  65. -------------------
  66. Don't do it. If your question hasn't been answered, see the top of this document for tips. These types of post add nothing to the conversation and may be moderated.
  67. Posting Code
  68. ------------
  69. Long bits of code are confusing to read through in a forums context. Please use http://elgg.pastebin.com to post long bits of code and provide the Paste Bin link instead of directly posting the code.
  70. Good Ideas
  71. ==========
  72. Not policies, but good ideas.
  73. Say thanks
  74. ----------
  75. Did someone help you? Be sure to thank them! The community site is run by volunteers. No one has to help you with your problem. Be sure to show your appreciation!
  76. Give back
  77. ---------
  78. Have a tip for Elgg? See someone with a similar problem you had? You've been there and can help them out, so give them a hand!