add doc/faq.md Troubleshooting page; close PrairieLearn#185

Author: mwest1066

ChangeLog.md

@@ -19,6 +19,8 @@
 
   * Fix missing user list in dropdown after UID change.
 
+  * Add "Troubleshooting" documentation page with frequently asked questions.
+
 * __1.16.1__ - 2015-10-12
 
   * Fix alignment of date plots on Safari.

README.md

@@ -6,11 +6,12 @@ of a server component that presents questions and other data via an
 API, and a web-app that interfaces with the user and communicates with
 the server.
 
-[ChangeLog: versions of PrairieLearn with change list](https://github.com/PrairieLearn/PrairieLearn/blob/master/ChangeLog.md)
+* [ChangeLog: versions of PrairieLearn with change list](https://github.com/PrairieLearn/PrairieLearn/blob/master/ChangeLog.md)
 
 ## User Documentation
 
-* [Overview](https://github.com/PrairieLearn/PrairieLearn/blob/master/doc/overview.md)
+* [Troubleshooting and other questions](https://github.com/PrairieLearn/PrairieLearn/blob/master/doc/faq.md)
+* [Overview of PrairieLearn](https://github.com/PrairieLearn/PrairieLearn/blob/master/doc/overview.md)
 * [Installing and running PrairieLearn on Linux or OS X](https://github.com/PrairieLearn/PrairieLearn/blob/master/doc/installingLinux.md)
 * [Installing and running PrairieLearn on Windows](https://github.com/PrairieLearn/PrairieLearn/blob/master/doc/installingWindows.md)
 * [PrairieLearn server configuration](https://github.com/PrairieLearn/PrairieLearn/blob/master/doc/serverConfig.md)

doc/faq.md

@@ -0,0 +1,47 @@
+
+# Troubleshooting and other questions
+
+
+## My changes to a test don't show up
+
+There are several actions needed to activate changes to tests while in development mode on your local computer:
+
+1. Make sure the test changes are really saved to disk in the course directory that PrairieLearn is using.
+
+1. Reload the server (Ctrl-C in the server window, then re-run `node server`).
+
+1. Reload the PrairieLearn webpage in your browser.
+
+1. If this is an "exam"-style test, then you need to "reset" the test to force PrairieLearn to re-randomize the test instance (click "Reset" on the test "Admin" page). See [Writing tests](writingTests.md) for details.
+
+On the production server you only need to sync the new test code (on the "Sync" page). If you want existing test instances to be updated with the new code then you will need to reset the test (**but this will remove all existing progress by students on that test**).
+
+## I changed a question but the changes aren't showing up
+
+When you change a question it only affects newly-generated variants of the question. To make sure you are getting the new version of a question on your local computer:
+
+1. Make sure the question changes are really saved to disk in the course directory that PrairieLearn is using.
+
+1. Reload the server (Ctrl-C in the server window, then re-run `node server`).
+
+1. Reload the PrairieLearn webpage in your browser.
+
+1. If this is a "homework"-type style test then you should get the question wrong and click "Do this question again" to prompt the generation of a new question variant.
+
+1. If this is an "exam"-style test then you need to "reset" the test to force PrairieLearn to regenerate the question instances (click "Reset" on the test "Admin" page). See [Writing tests](writingTests.md) for details.
+
+On the production server you only need to sync the new question code (on the "Sync" page), and then force a regeneration of the question variant as described above.
+
+
+## How do I reset a test for a particular student?
+
+The "Admin" page for each test allows you to reset a test for all users or for the current user. To reset a test for a particular student, first use the "User" page to change your the active user to the particular student, make sure you are still in the "Instructor" role, then go back to the test "Admin" page and click "Reset for current user". **Be very careful resetting tests after students have started working on them. Resetting will remove all progress by that student.**
+
+
+## How do I view PrairieLearn errors?
+
+PrairieLearn errors are output in different places depending on where the error occurs:
+
+* Server-side errors are output in the terminal window where you ran `node server`. Extra debugging information can be output here by adding `console.log()` statements inside question `server.js` files.
+
+* Client-side errors are output in the JavaScript console inside your web browser. In Chrome, this can be accessed from the menu item *View → Developer → JavaScript Console*. Additional debugging information can be output here with `console.log()` from within question `client.js` files.