Version 2.1.2

CHANGELOG.md

@@ -1,6 +1,16 @@
 
 # Changelog
 
+## 2.1.2 (2016-12-12)
+
+  * Hide the "add" button in readonly mode
+  * Add a contributing guide
+
+## 2.1.1 (2016-11-20)
+
+  * Use arrows instead of plus and minus for collapsibles/expanders
+  * Supply more detailed 500 messages
+
 ## 2.1.0 (2016-11-07)
 
   * Allow for configuration files to be JavaScript rather than JSON

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+
+Contributing Guide
+==================
+
+Thanks for getting involved :tada:
+
+The Pa11y team loves to see new contributors, and we strive to provide a welcoming and inclusive environment. We ask that all contributors read and follow [our code of conduct][code-of-conduct] before joining. If you represent an organisation, then you might find our [guide for companies][companies] helpful.
+
+Our website outlines the many ways that you can contribute to Pa11y:
+
+  - [Help us to talk to our users][communications]
+  - [Help us out with design][designers]
+  - [Help us with our code][developers]
+
+
+
+[code-of-conduct]: http://pa11y.org/contributing/code-of-conduct/
+[communications]: http://pa11y.org/contributing/communications/
+[companies]: http://pa11y.org/contributing/companies/
+[designers]: http://pa11y.org/contributing/designers/
+[developers]: http://pa11y.org/contributing/developers/

README.md

@@ -82,10 +82,12 @@ The boot configurations for Pa11y Dashboard are as follows. Look at the sample J
 This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.
 
 
-Development
+Contributing
------------
+------------
 
-To develop Pa11y Dashboard, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup).
+There are many ways to contribute to Pa11y Dashboard, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
+
+If you're ready to contribute some code, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup).
 
 You'll need to start the application in test mode with:
 
@@ -157,5 +159,5 @@ Copyright © 2013–2016, Springer Nature
 [info-build]: https://travis-ci.org/pa11y/dashboard
 [shield-license]: https://img.shields.io/badge/license-GPL%203.0-blue.svg
 [shield-node]: https://img.shields.io/badge/node.js%20support-4–6-brightgreen.svg
-[shield-version]: https://img.shields.io/badge/version-2.1.0-blue.svg
+[shield-version]: https://img.shields.io/badge/version-2.1.2-blue.svg
 [shield-build]: https://img.shields.io/travis/pa11y/dashboard/master.svg

package.json

@@ -1,52 +1,52 @@
 {
-	"name": "pa11y-dashboard",
+  "name": "pa11y-dashboard",
-	"version": "2.1.0",
+  "version": "2.1.2",
-	"private": true,
+  "private": true,
-
+  "description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
-	"description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
+  "keywords": [
-	"keywords": [ "accessibility", "analysis", "report" ],
+    "accessibility",
-	"contributors": [
+    "analysis",
-		"Perry Harlock (http://www.phwebs.co.uk/)",
+    "report"
-		"Rowan Manning (http://rowanmanning.com/)"
+  ],
-	],
+  "contributors": [
-
+    "Perry Harlock (http://www.phwebs.co.uk/)",
-	"repository": {
+    "Rowan Manning (http://rowanmanning.com/)"
-		"type": "git",
+  ],
-		"url": "https://github.com/pa11y/dashboard.git"
+  "repository": {
-	},
+    "type": "git",
-	"homepage": "https://github.com/pa11y/dashboard",
+    "url": "https://github.com/pa11y/dashboard.git"
-	"bugs": "https://github.com/pa11y/dashboard/issues",
+  },
-	"license": "GPL-3.0",
+  "homepage": "https://github.com/pa11y/dashboard",
-
+  "bugs": "https://github.com/pa11y/dashboard/issues",
-	"engines": {
+  "license": "GPL-3.0",
-		"node": ">=4"
+  "engines": {
-	},
+    "node": ">=4"
-	"dependencies": {
+  },
-		"body-parser": "~1.15",
+  "dependencies": {
-		"chalk": "~1.1",
+    "body-parser": "~1.15",
-		"compression": "~1.6",
+    "chalk": "~1.1",
-		"express": "~4.14",
+    "compression": "~1.6",
-		"express-hbs": "~1.0",
+    "express": "~4.14",
-		"http-headers": "^3.0.1",
+    "express-hbs": "~1.0",
-		"moment": "~2.13",
+    "http-headers": "^3.0.1",
-		"pa11y-webservice": "^2.1.2",
+    "moment": "~2.13",
-		"pa11y-webservice-client-node": "^1.2.1",
+    "pa11y-webservice": "^2.1.2",
-		"underscore": "~1.8"
+    "pa11y-webservice-client-node": "^1.2.1",
-	},
+    "underscore": "~1.8"
-	"devDependencies": {
+  },
-		"bower": "~1.7",
+  "devDependencies": {
-		"cheerio": "~0.20",
+    "bower": "~1.7",
-		"jscs": "^2",
+    "cheerio": "~0.20",
-		"jshint": "^2",
+    "jscs": "^2",
-		"less": "~2.7",
+    "jshint": "^2",
-		"mocha": "^2",
+    "less": "~2.7",
-		"proclaim": "^3",
+    "mocha": "^2",
-		"request": "^2.74",
+    "proclaim": "^3",
-		"uglify-js": "~2.6"
+    "request": "^2.74",
-	},
+    "uglify-js": "~2.6"
-
+  },
-	"scripts": {
+  "scripts": {
-		"start": "node index.js",
+    "start": "node index.js",
-		"test": "make ci"
+    "test": "make ci"
-	}
+  }
 }

public/js/site.js

@@ -77,11 +77,11 @@ $(document).ready(function(){
     expandLink.click( function(){
 		$(this).next().slideToggle('slow', function(){});
         if ($(this).hasClass('showing')) {
-            $(this).find('span.expander').html('+');
+            $(this).find('span.expander').html('↓');
             $(this).attr('aria-expanded', false);
         }
         else {
-            $(this).find('span.expander').html('-');
+            $(this).find('span.expander').html('↑');
             $(this).attr('aria-expanded', true);
         }
         $(this).toggleClass('showing');

view/500.html

@@ -15,9 +15,13 @@ You should have received a copy of the GNU General Public License
 along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 }}
 <div class="col-md-8">
-	<h1>Eeek! 500 error. This is serious.</h1>
+	<h1>Eeek! 500 error.</h1>
-	<p class="h2">There isn't much you can do about this.</h2>
+	<p class="h2">Let's see what we can do here:</h2>
-	<p class="h4">Give it another go or try the <a href="/">home page</a>.</h4>
+	<ul>
+		<li>Do you have <a href="https://www.mongodb.com/">MongoDB</a> installed and <code>mongod</code> running?</li>
+		<li>Check out the <a href="https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md">Troubleshooting doc</a> for more information.</li>
+		<li>Search for a related <a href="https://github.com/pa11y/dashboard/issues">Github issue</a>, or open one yourself.</li>
+	</ul>
 	{{#if error}}
 		<h2>Stack-Trace</h2>
 		<pre>{{error.stack}}</pre>

view/partial/result.html

@@ -73,7 +73,7 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 <div class="col-md-9" data-role="expandable-results" role="main">
 	{{#if mainResult.count.error}}
 		<div class="heading label-danger pointer showing first" id="errors" data-test="task-errors" data-role="expander" role="button" tabindex="0" aria-expanded="true" aria-controls="errors-list">
-			<span class="pull-right expander"> - <span class="hide">(close panel)</span></span>
+			<span class="pull-right expander"> ↑ <span class="hide">(close panel)</span></span>
 			Errors ( {{mainResult.count.error}} )
 		</div>
 		<div class="task-danger tasks-list collapse clearfix in" id="errors-list">
@@ -109,7 +109,7 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 
 	{{#if mainResult.count.warning}}
 		<div class="heading label-warning pointer" id="warnings" data-test="task-warnings" data-role="expander" role="button" tabindex="0" aria-expanded="false" aria-controls="warnings-list">
-			<span class="pull-right expander"> + <span class="hide">(open panel)</span></span>
+			<span class="pull-right expander"> ↓ <span class="hide">(open panel)</span></span>
 			Warnings ( {{mainResult.count.warning}} )
 		</div>
 		<div class="task-warning tasks-list collapse clearfix" id="warnings-list">
@@ -145,7 +145,7 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 
 	{{#if mainResult.count.notice}}
 		<div class="heading label-info pointer" id="notices" data-test="task-notices" data-role="expander" role="button" tabindex="0" aria-expanded="false" aria-controls="notices-list">
-			<span class="pull-right expander"> + <span class="hide">(open panel)</span></span>
+			<span class="pull-right expander"> ↓ <span class="hide">(open panel)</span></span>
 			Notices ( {{mainResult.count.notice}} )
 		</div>
 		<div class="task-info tasks-list collapse clearfix" id="notices-list">
@@ -180,7 +180,7 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 
 	{{#if mainResult.ignore.length}}
 		<div class="heading label-default pointer" id="ignore" data-role="expander" role="button" tabindex="0" aria-expanded="false" aria-controls="ignore-list">
-			<span class="pull-right expander"> + <span class="hide">(open panel)</span></span>
+			<span class="pull-right expander"> ↓ <span class="hide">(open panel)</span></span>
 			Ignored Rules ( {{mainResult.ignore.length}} )
 		</div>
 		<div class="task-default tasks-list collapse clearfix" id="ignore-list">

view/partial/tasks.html

@@ -16,19 +16,15 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 }}
 
 <ul class="list-unstyled clearfix crunch-bottom">
-	<li class="col-md-4 col-sm-6 task-card add-task">
+
-		{{#if readonly}}
+	{{#unless readonly}}
-			<span class="well task-card-link crunch-bottom">
+	        <li class="col-md-4 col-sm-6 task-card add-task">
-				<p class="h3 crunch">Add new URL</p>
-				<p class="supersize-me crunch">+</p>
-			</span>
-		{{else}}
 			<a class="well task-card-link crunch-bottom" data-role="add-task" href="/new" data-test="add-task">
 				<p class="h3 crunch">Add new URL</p>
 				<p class="supersize-me crunch">+</p>
 			</a>
-		{{/if}}
+		</li>
-	</li>
+	{{/unless}}
 	{{#each tasks}}
 		<li class="col-md-4 col-sm-6 task-card" data-test="task" data-role="task" data-keywords="{{lowercase name}} {{lowercase standard}} {{simplify-url url}}">
 			<a class="well task-card-link crunch-bottom" title="Details for URL {{simplify-url url}}" href="{{href}}">
@@ -49,14 +45,14 @@ along with Pa11y Dashboard.  If not, see <http://www.gnu.org/licenses/>.
 			</a>
 			{{#unless ../readonly}}
 				<div class="btn-group options-button text-right">
-						<button type="button" class="btn btn-info btn-xs dropdown-toggle" data-toggle="dropdown"><span class="sr-only">Options</span><span class="glyphicon glyphicon-cog"></span></button>
+					<button type="button" class="btn btn-info btn-xs dropdown-toggle" data-toggle="dropdown"><span class="sr-only">Options</span><span class="glyphicon glyphicon-cog"></span></button>
-						<ul class="dropdown-menu pull-right" role="menu">
+					<ul class="dropdown-menu pull-right" role="menu">
-							<li><a href="{{href}}/edit">Edit this task</a></li>
+						<li><a href="{{href}}/edit">Edit this task</a></li>
-							<li><a href="{{href}}/delete">Delete this task</a></li>
+						<li><a href="{{href}}/delete">Delete this task</a></li>
-							<li class="divider"></li>
+						<li class="divider"></li>
-							<li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li>
+						<li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li>
-						</ul>
+					</ul>
-					</div>
+				</div>
 			{{/unless}}
 		</li>
 	{{/each}}