From 40b6e79f81879fbe1c3d967fddd764868f485edd Mon Sep 17 00:00:00 2001 From: hollsk Date: Thu, 6 Oct 2016 16:40:22 +0100 Subject: [PATCH 1/2] add troubleshooting guide and link on the index page --- README.md | 3 +++ TROUBLESHOOTING.md | 27 +++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 TROUBLESHOOTING.md diff --git a/README.md b/README.md index a7eea78..9c159ca 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,8 @@ NODE_ENV=development node index.js See [development instructions](#development) for more information about running locally (and restarting automatically when files change). +If you run into problems, check the [troubleshooting][troubleshooting guide]. + Configurations -------------- @@ -148,6 +150,7 @@ Copyright © 2013–2016, Springer Nature [sidekick-proposal]: https://github.com/pa11y/sidekick/blob/master/PROPOSAL.md [travis]: https://travis-ci.org/pa11y/dashboard [travis-img]: https://travis-ci.org/pa11y/dashboard.png?branch=master +[troubleshooting]: https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md [info-license]: LICENSE [info-node]: package.json diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md new file mode 100644 index 0000000..097ca3e --- /dev/null +++ b/TROUBLESHOOTING.md @@ -0,0 +1,27 @@ +Troubleshooting +=============== + + +Common issues +----- + +* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [mongo-install][latest version of MongoDB] installed, and that it's running - it doesn't always start automatically. +* Error messages saying that pa11y-webservice isn't running may be due to dependency installation problems. Try deleting your `pa11y-dashboard/node_modules` directory and running `npm install` again. + + +Check to see if the issue has been reported +----- + +* Check the [issues][issue tracker] for similar issues. + + +Create an issue +----- + +If all else fails, [create-issue][create an issue] and we'll help you. Please include your node.js, Phantom, and MongoDB version numbers, and your operating system. + + +[issues]: https://github.com/pa11y/dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue +[mongo-install]: https://docs.mongodb.org/manual/installation/ +[create-issue]: https://github.com/pa11y/dashboard/issues/new + From 8c4517c83039dfaf378666f611ca4ea3608fff19 Mon Sep 17 00:00:00 2001 From: hollsk Date: Thu, 6 Oct 2016 17:12:50 +0100 Subject: [PATCH 2/2] put the links and refs the right way around --- README.md | 2 +- TROUBLESHOOTING.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9c159ca..2e81b33 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ NODE_ENV=development node index.js See [development instructions](#development) for more information about running locally (and restarting automatically when files change). -If you run into problems, check the [troubleshooting][troubleshooting guide]. +If you run into problems, check the [troubleshooting guide][troubleshooting]. Configurations diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 097ca3e..4ab00cb 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -5,20 +5,20 @@ Troubleshooting Common issues ----- -* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [mongo-install][latest version of MongoDB] installed, and that it's running - it doesn't always start automatically. +* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [latest version of MongoDB][mongo-install] installed, and that it's running - it doesn't always start automatically. * Error messages saying that pa11y-webservice isn't running may be due to dependency installation problems. Try deleting your `pa11y-dashboard/node_modules` directory and running `npm install` again. Check to see if the issue has been reported ----- -* Check the [issues][issue tracker] for similar issues. +* Check the [issue tracker][issues] for similar issues. Create an issue ----- -If all else fails, [create-issue][create an issue] and we'll help you. Please include your node.js, Phantom, and MongoDB version numbers, and your operating system. +If all else fails, [create an issue][create-issue] and we'll help you. Please include your node.js, Phantom, and MongoDB version numbers, and your operating system. [issues]: https://github.com/pa11y/dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue