Update support documentation for modern times · recaptime.dev/phorge@4cb2ec1

+3

src/docs/book/user.book

··· 31 31 }, 32 32 "fieldmanual": { 33 33 "name": "Field Manuals" 34 + }, 35 + "cellar": { 36 + "name": "Musty Cellar" 34 37 } 35 38 } 36 39 }

+23 -11

src/docs/contributor/bug_reports.diviner

··· 3 3 4 4 Describes how to file an effective Phabricator bug report. 5 5 6 + Include Reproduction Steps! 7 + =========================== 8 + 9 + IMPORTANT: When filing a bug report, you **MUST** include reproduction 10 + instructions. We can not help fix bugs we can not reproduce, and will not 11 + accept reports which omit reproduction instructions. See below for details. 12 + 13 + 6 14 Overview 7 15 ======== 8 16 ··· 27 35 28 36 For general information on contributing to Phabricator, see 29 37 @{article:Contributor Introduction}. 38 + 30 39 31 40 Common Fixes 32 41 ============ ··· 73 82 Before filing a bug, make sure you're filing an issue against something we 74 83 support. 75 84 85 + **We can NOT help you with issues we can not reproduce.** It is critical that 86 + you explain how to reproduce the issue when filing a report. 87 + 76 88 **We do NOT support prototype applications.** If you're running into an issue 77 89 with a prototype application, you're on your own. For more information about 78 90 prototype applications, see @{article:User Guide: Prototype Applications}. ··· 100 112 Otherwise, if you're having an issue with a supported first-party application 101 113 and followed the upstream install instructions on a normal computer, we're happy 102 114 to try to help. 115 + 103 116 104 117 Getting More Information 105 118 ======================== ··· 121 134 troubleshooting. Adjusting settings or enabling debugging modes may give 122 135 you more information about the issue. 123 136 137 + 124 138 Reproducibility 125 139 =============== 126 140 ··· 135 149 issue. 136 150 137 151 It is nearly impossible for us to resolve many issues if we can not reproduce 138 - them. 152 + them. We will not accept reports which do not contain the information required 153 + to reproduce problems. 154 + 139 155 140 156 Unreproducible Problems 141 157 ======================= ··· 161 177 issues which we can't reproduce. You can make sure we're able to help resolve 162 178 your issue by generating clear reproduction steps. 163 179 180 + 164 181 Create a Task in Maniphest 165 182 ========================== 166 183 ··· 168 185 and have the best reproduction instructions you can come up with, you're ready 169 186 to file an issue. 170 187 171 - We'll look at any issue report we can find (we monitor IRC, email, 172 - StackOverflow, Quora, Facebook and Twitter), but the upstream Maniphest is the 173 - authoritative bug tracker and the best place to file: 188 + It is **particularly critical** that you include reproduction steps. We will 189 + not accept reports which describe issues we can not reproduce. 174 190 175 - https://secure.phabricator.com/maniphest/task/create/ 191 + (NOTE) https://secure.phabricator.com/maniphest/task/create/ 176 192 177 193 If you don't want to file there (or, for example, your bug relates to being 178 194 unable to log in or unable to file an issue in Maniphest) you can file on any ··· 182 198 | Effectiveness | Filing Method | 183 199 |---|---| 184 200 | Best | Upstream Maniphest | 185 - | Ehhh | Quora, StackOverflow, Facebook, email, etc. | 201 + | Ehhh | Quora, StackOverflow, Facebook, Jelly, email, etc. | 186 202 | What | Passive-aggressive tweet | 187 203 188 - If you have a quick question or want to discuss something before filing an 189 - issue, IRC is a great way to get a sanity check first. You can find information 190 - about IRC in @{article: Give Feedback! Get Support!}. 191 204 192 205 Next Steps 193 206 ========== ··· 195 208 Continue by: 196 209 197 210 - learning about @{article: Contributing Feature Requests}; or 198 - - reading general support information in 199 - @{article: Give Feedback! Get Support!}; or 211 + - reading general support information in @{article:Support Resources}; or 200 212 - returning to the @{article:Contributor Introduction}.

+8 -15

src/docs/contributor/contrib_intro.diviner

··· 23 23 24 24 - Send us an email or drop by IRC just to say "thanks". A big part of the 25 25 reason we build this software is to help people solve problems, and knowing 26 - that our efforts are appreciated is really rewarding. You can find ways to 27 - get in touch in @{article:Give Feedback! Get Support!} 26 + that our efforts are appreciated is really rewarding. 28 27 - Recommend Phabricator to people who you think might find it useful. Our 29 28 most powerful growth channel is word of mouth, and mentioning or tweeting 30 29 about Phabricator helps the project grow. If writing a tweet sounds like ··· 40 39 - Report bugs and request features. We may not always be able to fix or build 41 40 things right away, but knowing about issues users are encountering or 42 41 features they'd like to see improves our ability to plan and prioritize. 43 - For ways to do this, see @{article:Give Feedback! Get Support!} 44 42 - For details on reporting bugs, see @{article:Contributing Bug Reports}. 45 43 - For details on requesting features, see @{article:Contributing Feature 46 44 Requests}. ··· 48 46 6-12 months currently exists on the [[ Roadmap ]] or in Maniphest. Telling 49 47 us about use cases you have can help us build better products when the time 50 48 comes to write the code. 51 - - Hang out in IRC, and maybe answer a question or two. IRC is a completely 52 - legit place for serious hackers to hang out anyway, but while you're there 53 - you might see someone ask a question that you know the answer to. Helping 54 - them out (or pointing them to the right documentation) is a big help to us. 55 - You can find details about the IRC channel in 56 - @{article:Give Feedback! Get Support!} 49 + 50 + If all of this sounds nice but you really just want to write some code, be 51 + aware that this project often presents a high barrier to entry for new 52 + contributors. To continue, see @{article:Contributing Code}. 57 53 58 - If all of this sounds nice but you really just want to write some code, that's 59 - awesome too. To get started with contributing code, see 60 - @{article:Contributing Code}. 61 54 62 55 Next Steps 63 56 ========== ··· 65 58 Continue by: 66 59 67 60 - learning about bug reports in @{article:Contributing Bug Reports}; 68 - - learning about feature requests in @{article:Contributing Feature Requests}; 69 - - learning about code contributions in @{article:Contributing Code}; or 70 - - getting in touch with @{article:Give Feedback! Get Support!} 61 + - learning about feature requests in 62 + @{article:Contributing Feature Requests}; or 63 + - learning about code contributions in @{article:Contributing Code}.

+20 -9

src/docs/contributor/feature_requests.diviner

··· 3 3 4 4 Describes how to file an effective Phabricator feature request. 5 5 6 + Describe Your Problem! 7 + ====================== 8 + 9 + IMPORTANT: When filing a feature request, you **MUST** describe the root 10 + problem you are facing. We will not accept feature requests which do not 11 + include a problem description. See below for details. 12 + 6 13 Overview 7 14 ======== 8 15 ··· 138 145 Describe Problems 139 146 ================= 140 147 141 - When you file a feature request, it is really helpful to describe the problem 142 - you're facing first, not just your desired solution. 148 + When you file a feature request, we need you to describe the problem you're 149 + facing first, not just your desired solution. Describing the problem you are 150 + facing is the **most important part** of a feature request. 143 151 144 152 Often, your problem may have a lot in common with other similar problems. If we 145 153 understand your use case we can compare it to other use cases and sometimes find ··· 158 166 159 167 If you only describe the solution and not the problem, we can't generalize, 160 168 contextualize, merge, reframe, or offer alternative solutions or workarounds. 169 + 170 + You must describe the problem you are facing when filing a feature request. We 171 + will not accept feature requests which do not contextualize the request by 172 + describing the root problem. 161 173 162 174 163 175 Hypotheticals ··· 206 218 207 219 If you think your feature might be a good fit for the upstream, have reasonable 208 220 expectations about it, and have a good description of the problem you're trying 209 - to solve, you're ready to file a feature request: 221 + to solve, you're ready to file a feature request. 210 222 211 - https://secure.phabricator.com/maniphest/task/create/ 223 + It is **particularly critical** that you describe the problem you are facing, 224 + not just the feature you want. We will not accept feature requests which do 225 + not describe the root problem the feature is intended to resolve. 212 226 213 - If you have a quick question or want to discuss something before filing a 214 - request, IRC is the best way to get a quick answer. You can find information 215 - about IRC and other support channels in @{article: Give Feedback! Get Support!}. 227 + (NOTE) https://secure.phabricator.com/maniphest/task/create/ 216 228 217 229 218 230 Next Steps ··· 221 233 Continue by: 222 234 223 235 - learning about @{article: Contributing Bug Reports}; or 224 - - reading general support information in 225 - @{article: Give Feedback! Get Support!}; or 236 + - reading general support information in @{article:Support Resources}; or 226 237 - returning to the @{article:Contributor Introduction}.

+3 -40

src/docs/user/feedback.diviner

··· 1 1 @title Give Feedback! Get Support! 2 2 @short Feedback/Support 3 - @group intro 4 - 5 - How to give us feedback, report bugs, and request features, and get support for 6 - problems with Phabricator. 7 - 8 - Overview 9 - ======== 10 - 11 - We'd love to hear your feedback about Phabricator, whether it's good or bad. The 12 - best ways to provide feedback and get support are: 13 - 14 - - For bug reports and feature requests, file a task in our task tracker, 15 - Maniphest. 16 - - For questions and real-time chat, join the IRC channel. 17 - - If you just want to provide some quick feedback, you can tweet at 18 - us ([[ http://twitter.com/phabricator | @phabricator ]]). 3 + @group cellar 19 4 20 - Bugs and Requests 21 - ===================== 5 + Deprecated. 22 6 23 - The best way to report bugs and request features is through 24 - [[http://secure.phabricator.com/maniphest/task/create/ | Maniphest]]. For 25 - information on filing good bug reports and feature requests, see: 26 - 27 - - @{article:Contributing Bug Reports} 28 - - @{article:Contributing Feature Requests} 29 - 30 - IRC 31 - ========== 32 - 33 - We're active in `#phabricator` on FreeNode, and it's the best place to ask 34 - questions and get support. 35 - 36 - Next Steps 37 - ========== 38 - 39 - Continue by: 40 - 41 - - learning more about bug reports with @{article:Contributing Bug Reports}; or 42 - - learning more about feature requests with 43 - @{article:Contributing Feature Requests}; or 44 - - contributing to Phabricator with @{article:Contributor Introduction}. 7 + This article has moved to @{article:Support Resources}.

+11 -16

src/docs/user/reporting_security.diviner

··· 3 3 4 4 Describes how to report security vulnerabilities in Phabricator. 5 5 6 - = Overview = 6 + Overview 7 + ======== 7 8 8 9 Phabricator runs a disclosure and award program through 9 10 [[ https://www.hackerone.com/ | HackerOne ]]. This program is the best way to ··· 19 20 We have a 24 hour response timeline, and are usually able to respond to (and, 20 21 very often, fix) issues more quickly than that. 21 22 22 - = Other Channels = 23 23 24 - You can also contact us on another channel if you prefer. See 25 - @{article:Give Feedback! Get Support!} for a list of ways to get in touch 26 - with us. 24 + Other Channels 25 + ============== 27 26 28 - = Getting Notified = 27 + If you aren't sure if something qualifies or don't want to report via 28 + HackerOne, you can submit the issue as a normal bug report. For instructions, 29 + see @{article:Contributing Bug Reports}. 29 30 30 - When we fix significant security vulnerabilities, we currently publish 31 - information: 32 31 33 - - on our [[ https://www.facebook.com/phabricator | Facebook Page ]]; 34 - - on our [[ https://twitter.com/phabricator | Twitter Feed ]]; 35 - - and on IRC (`#phabricator` on FreeNode). 32 + Get Updated 33 + =========== 36 34 37 - If you'd prefer to receive information on other channels, let us know. 38 - 39 - General information about security is reported monthly in the 40 - [[ http://phabricator.org/changelog/ | Changelog ]]. This includes low impact 41 - issues, reports we did not act on, and other details. 35 + General information about security changes is reported weekly in the 36 + [[ https://secure.phabricator.com/w/changelog/ | Changelog ]].

+125

src/docs/user/support.diviner

··· 1 + @title Support Resources 2 + @short Support 3 + @group intro 4 + 5 + Resources for reporting bugs, requesting features, and getting support. 6 + 7 + Overview 8 + ======== 9 + 10 + This document describes available support resources. 11 + 12 + The upstream provides active, free support for a narrow range of problems 13 + (primarily, security issues and reproducible bugs). 14 + 15 + The upstream does not provide free support for general problems with installing 16 + or configuring Phabricator. You may be able to get some help with these 17 + kinds of issues from the community. 18 + 19 + 20 + Reporting Security Vulnerabilities 21 + ================================== 22 + 23 + The upstream accepts, fixes, and awards bounties for reports of material 24 + security issues with the software. 25 + 26 + To report security issues, see @{article:Reporting Security Vulnerabilities}. 27 + 28 + 29 + Reporting Bugs 30 + ============== 31 + 32 + The upstream will accept **reproducible** bug reports in modern, first-party 33 + production code running in reasonable environments. 34 + 35 + To report bugs, see @{article:Contributing Bug Reports}. 36 + 37 + 38 + Requesting Features 39 + =================== 40 + 41 + The upstream accepts feature requests which **describe problems** you would 42 + like Phabricator to be able to solve. 43 + 44 + To request features, see @{article:Contributing Feature Requests}. 45 + 46 + 47 + Contributing 48 + ============ 49 + 50 + Phabricator is a very difficult project to contribute to. New contributors 51 + will face a high barrier to entry. 52 + 53 + If you'd like to contribute to Phabricator, start with 54 + @{article:Contributor Introduction}. 55 + 56 + 57 + 58 + Installation and Setup Help 59 + =========================== 60 + 61 + Installation and setup help is available from the upstream at consulting rates. 62 + See [[ https://secure.phabricator.com/w/consulting/ | Consulting ]] for details. 63 + 64 + Helping individual installs navigate unique setup problems takes our time 65 + away from developing Phabricator, so we can not offer this service for free. 66 + 67 + You may be able to get free help with these issues from the community. See 68 + below for details. 69 + 70 + 71 + Hosting 72 + ========= 73 + 74 + The upstream offers Phabricator as a hosted service at 75 + [[ https://phacility.com | Phacility ]]. This simplifies setting up and 76 + operating a Phabricator instance, and gives you access to a broader range 77 + of upstream support services. 78 + 79 + Running this service gives us a strong financial incentive to make installing 80 + and operating Phabricator as difficult as possible. Blinded by greed, we toil 81 + endlessly to make installation a perplexing nightmare that none other than 82 + ourselves can hope to navigate. 83 + 84 + 85 + Prioritization 86 + ============== 87 + 88 + The upstream offers prioritization, a service which allows you to control 89 + our roadmap and get features you're interested in built sooner at reasonable 90 + rates. See 91 + [[ https://secure.phabricator.com/w/prioritization/ | Prioritization ]] for 92 + details. 93 + 94 + 95 + Consulting 96 + ========== 97 + 98 + The upstream offers general-purpose consulting services. See 99 + [[ https://secure.phabricator.com/w/consulting/ | Consulting ]] for details. 100 + 101 + 102 + Community 103 + ========= 104 + 105 + These resources are not provided by the upstream. They are not official support 106 + channels and you may not receive support here, or you may receive help which is 107 + misleading or wrong. 108 + 109 + You may be able to get answers to questions on sites like 110 + [[ http://stackoverflow.com | Stack Overflow ]], 111 + [[ https://www.quora.com | Quora ]], 112 + [[ https://jelly.co | Jelly ]], or 113 + [[ https://twitter.com | Twitter ]]. The upstream occasionally participates on 114 + these sites but these are not official support channels and you should not 115 + expect to receive a response. 116 + 117 + There is a 118 + [[ https://secure.phabricator.com/conpherence/1336/ | General Chat ]] 119 + Conpherence room on this install, and you can ask questions in 120 + [[ https://secure.phabricator.com/ponder/ | Ponder ]]. These 121 + are not upstream support channels and you may not receive a response to 122 + questions, but someone in the community may be able to point you in the right 123 + direction. 124 + 125 + There is also a community IRC channel in `#phabricator` on FreeNode.

Configure Feed

Configure Feed