Skip to content

Commit

Permalink
docs(troubleshooting): add section
Browse files Browse the repository at this point in the history
  • Loading branch information
louh committed Aug 3, 2019
1 parent 4ff493a commit 4ba2dfc
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs/support/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Troubleshooting

This page is a work in progress.


Error codes
-----------

Expand All @@ -18,3 +19,30 @@ These are error codes that may occur while using Streetmix.
| | sent street data that had | |
| | no data in it. | |
+-------------+-------------------------------+-------------------------------+


.. _troubleshooting-development-issues:

Development issues
------------------

While developing Streetmix, here are solutions to some problems that may arise.


Strategies for resolving most common issues
+++++++++++++++++++++++++++++++++++++++++++

When you run into problems, **try this first!**

- Update your global ``node`` and ``npm`` versions to the latest versions.
- Remove the :file:`node_modules` and :file:`.cache` folders, if present, and reinstall (:ref:`install-streetmix`).
- Ensure that you are installing and running Streetmix with ``npm``, not ``yarn``.


Specific issues
+++++++++++++++

This section is for troubleshooting specific issues.

- **The server keeps restarting in a loop** with the ``EADDRINUSE`` error code. We have documented a solution in `GitHub issue #983 <https://github.com/streetmix/streetmix/issues/983>`_.

4 changes: 3 additions & 1 deletion docs/technical/installing-streetmix.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _install-streetmix:

Installing Streetmix
====================

Expand Down Expand Up @@ -379,4 +381,4 @@ You can also do it one time by starting the server like this:
Troubleshooting
---------------

If you run into problems, please reach out to us. :ref:`contact`.
If you run into problems, please see the :ref:`troubleshooting-development-issues` section.

0 comments on commit 4ba2dfc

Please sign in to comment.