Documentation fixes and updates

Fix broken link and typo Tweak "how to report bug/request feature" page [ci skip]
ThinkUpLLC · May 24, 2012 · 1d94477 · 1d94477
1 parent 9b11f43
commit 1d94477
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 8 deletions.
diff --git a/docs/source/contribute/developers/documentation.rst b/docs/source/contribute/developers/documentation.rst
@@ -95,7 +95,7 @@ Example
 -------
 
 Here's a file that Gina's already added PHPDocumentor comments to:
-http://github.com/ginatrapani/thinkup/blob/master/webapp/controller/class.PublicTimelineController.php
+https://github.com/ginatrapani/ThinkUp/blob/master/webapp/_lib/model/class.Post.php
 
 This is what the documentation page that PHPDoc created looks like:
 http://thinkupapp.com/docs/ThinkUp/PublicTimelineController.html
diff --git a/docs/source/troubleshoot/report.rst b/docs/source/troubleshoot/report.rst
@@ -35,11 +35,33 @@ Step 3: Contact the Community
 Send an email to the `ThinkUp mailing list <http://groups.google.com/group/thinkupapp>`_ describing your problem or
 feature idea. Be specific.
 
-For bug reports, describe step by step exactly what you did and what went wrong, including application messaging word
-for word, as well as what version of ThinkUp you are running and what operating system and version of PHP and MySQL
-you are running.
+Write a Great Bug Report
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-For feature ideas, describe exactly how you think the new functionality should work, and include wireframes and 
+Help us help you! The  more information about your problem you share, the more likely it is that the community
+can help you.
+
+In your bug report, include the following information:
+
+* Your ThinkUp hosting provider
+* The version of ThinkUp you are running
+* Whether or not you have any special setup details (i.e., a subdomain, desktop installation, modified code, etc)
+* What you did before the bug occurred
+* What the application message or log contents were when the bug occurred
+* What the expected behavior was
+* What version of PHP and MySQL your ThinkUp host is running
+
+While the core development team can't respond to every bug report on the mailing list, volunteer community members
+help each other troubleshoot problems.
+
+Propose a New Feature
+^^^^^^^^^^^^^^^^^^^^^
+
+If you've got an idea for a new ThinkUp feature, we invite you to  :doc:`pull the source code and start
+building </contribute/developers/index>`! If you're not a coder, the better you pitch your feature idea to the
+community, the more likely an interested developer will work on it. 
+
+To pitch your feature idea, describe exactly how you think the new functionality should work, and include wireframes and 
 screenshots. Sell your idea to the community by clearly explaining its benefits and use cases, and how you plan to 
 help make the feature. We only build features which align with :doc:`ThinkUp's purpose </intro>`.
 

diff --git a/docs/source/userguide/accounts/index.rst b/docs/source/userguide/accounts/index.rst
@@ -54,8 +54,10 @@ User Permissions
 
 Currently there are two levels of user permissions in ThinkUp: user-level and administrator-level permissions.
 
-* **Users** cannot enable, disable, or configure plugins, or see a list of users for a given ThinkUp installation.
-* **Administrators** can enable, disable, and configure plugins, see a list of users on a given ThinkUp installation, see all the views for social media accounts registered on the installation, deactivate ThinkUp user accounts, and configure global application settings like whether or not registration is open to new users.
+*   **Users** cannot enable, disable, or configure plugins, or see a list of users for a given ThinkUp installation.
+*   **Administrators** can enable, disable, and configure plugins, see a list of users on a given ThinkUp installation,
+    see all the views for social media accounts registered on the installation, deactivate ThinkUp user accounts, and
+    configure global application settings like whether or not registration is open to new users.
 
 Every ThinkUp installation must have at least one administrator account. A ThinkUp installation can have any 
 number of user accounts, and it may have multiple administrator accounts.

diff --git a/docs/source/userguide/settings/plugins/facebook.rst b/docs/source/userguide/settings/plugins/facebook.rst
@@ -44,5 +44,5 @@ Help! I don't see Facebook pages I manage in the dropdown list
 
 If you're only seeing pages you "like" but not pages you manage in the pages dropdown list, delete your Facebook user
 account from ThinkUp, and re-add it. Authorize ThinkUp to get access to your managed pages, and then they will appear
-in the drodown list.
+in the dropdown list.