Merge pull request #3536 from nyu-ossd-s18/documentation

Improve Documentation

CONTRIBUTING.rst

@@ -61,6 +61,33 @@ from any directory in your system with::
 
     jupyter notebook
 
+Verification
+^^^^^^^^^^^^
+
+While running the notebook, select one of your notebook files (the file will have the extension ``.ipynb``).
+In the top tab you will click on "Help" and then click on "About". In the pop window you will see information about the version of Jupyter that you are running. You will see "The version of the notebook server is:".
+If you are working in development mode, you will see that your version of Jupyter notebook will include the word "dev".
+
+.. image:: ./docs/source/_static/images/jupyter-verification.png
+   :width: 40pt
+
+If it does not include the word "dev", you are currently not working in development mode and should follow the steps below to uninstall and reinstall Jupyter.
+
+Troubleshooting the Installation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you do not see that your Jupyter Notebook is not running on dev mode, it's possible that you are
+running other instances of Jupyter Notebook. You can try the following steps:
+
+1. Uninstall all instances of the notebook package. These include any installations you made using
+   pip or conda
+2. Run ``python3 -m pip install -e .`` in the notebook repository to install the notebook from there
+3. Run ``npm run build`` to make sure the Javascript and CSS are updated and compiled
+4. Launch with ``python3 -m notebook --port 8989``, and check that the browser is pointing to ``localhost:8989``
+   (rather than the default 8888). You don't necessarily have to launch with port 8989, as long as you use
+   a port that is neither the default nor in use, then it should be fine.
+5. Verify the installation with the steps in the previous section.
+
 
 Rebuilding JavaScript and CSS
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^