Skip to content

Commit

Permalink
Usability feedback (#1087)
Browse files Browse the repository at this point in the history
* Update team info

* Better checklist announcement

* Use npm start
  • Loading branch information
ericwbailey committed Aug 25, 2020
1 parent 569a4d4 commit 722b92b
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 25 deletions.
4 changes: 2 additions & 2 deletions .tours/code-tour.tour
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
{
"file": "package.json",
"line": 17,
"description": "These are the scripts you can runn in your command line application. `npm run a11yproject` will use Eleventy and Gulp to stitch everything together, open the site in your default browser, and then update when you make changes to anything in the `src/` directory."
"description": "These are the scripts you can runn in your command line application. `npm start` will use Eleventy and Gulp to stitch everything together, open the site in your default browser, and then update when you make changes to anything in the `src/` directory."
},
{
"file": "package.json",
Expand Down Expand Up @@ -130,4 +130,4 @@
"description": "This concludes a high-level explanation of this project's code! If you have any feedback or suggestions, please file an Issue or Pull Request.\n\nThank you for helping to make The A11Y Project better!"
}
]
}
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Once you have met [the prerequisites](#requirements), follow these steps to inst

### Running the website

After cloning and installing project Node.js modules, type `npm run a11yproject` into your command line application. This will tell Node.js to compile the project and turn it into a website.
After cloning and installing project Node.js modules, type `npm start` into your command line application. This will tell Node.js to compile the project and turn it into a website.

Your command line application will then display some information about Jekyll, including a line that starts with `Local:`. You can copy the URL it points to (it should read something like [`http://localhost:3000`](http://localhost:3000)) and paste it into a browser tab. This will load a local copy of the website that you can interact with to preview your changes.

Expand Down
6 changes: 3 additions & 3 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Modules are collections of code that help to do one specific task. They are comb

### Installing

The site will not run if you don't install the modules Node.js needs to build the website.
The site will not run if you don't install the modules Node.js needs to build the website.

You can install the Node.js modules The A11Y Project needs to run by typing `npm install` into your command line application.
You can install the Node.js modules The A11Y Project needs to run by typing `npm install` into your command line application.

### Removing and reinstalling

Expand All @@ -33,7 +33,7 @@ On a network, a localhost is a shorthand way for a computer to identify itself.

Sometimes another program will use the space on localhost that The A11Y Project tries to occupy, causing the project to be unable to run. This is like trying to call a phone number and getting a busy signal.

To fix this issue, try quitting your command line application and restarting it, then re-running `npm run a11yproject` in the root directory of The A11Y Project. You may also need to reboot your computer.
To fix this issue, try quitting your command line application and restarting it, then re-running `npm start` in the root directory of The A11Y Project. You may also need to reboot your computer.


## Other issues
Expand Down
15 changes: 10 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,23 @@
"homepage": "https://a11yproject.com/",
"version": "1.2.0",
"license": "Apache-2.0",
"author": "Dave Rupert <hello@a11yproject.com> (https://daverupert.com/)",
"author": "Dave Rupert (https://daverupert.com/)",
"contributors": [
"Carie Fisher <hello@a11yproject.com> (https://www.linkedin.com/in/cehfisher/)",
"Carie Fisher (https://www.linkedin.com/in/cehfisher/)",
"Dennis Gaebel <dennisgaebel@gmail.com> (https://droidpinkman.io/)",
"Eric Bailey <eric.w.bailey@gmail.com> (https://ericwbailey.design/)",
"Jerry Jones <hello@a11yproject.com> (http://jeremyjon.es/)",
"Jen Downs (https://jen.dev/)",
"Jerry Jones (http://jeremyjon.es/)",
"Saptak Sengupta (https://saptaks.website/)",
"Scott O'Hara <scottaohara@gmail.com> (https://www.scottohara.me/)",
"Scott Vinkle <scott.vinkle@shopify.com> (https://svinkle.me/)",
"Tatiana Mac <hello@a11yproject.com> (https://tatianamac.com/)"
"Soren Hamby <scott.vinkle@shopify.com> (https://svinkle.me/)",
"Tatiana Mac (https://tatianamac.com/)",
"Wayne Elgin (https://twitter.com/esjay)"
],
"scripts": {
"a11yproject": "npx eleventy --watch | gulp watch",
"start": "npx eleventy --watch | gulp watch",
"a11yproject": "npm start",
"publish": "npx gulp && npx eleventy",
"clean": "rm -rf ./dist",
"eleventy-build": "npx eleventy",
Expand Down
24 changes: 12 additions & 12 deletions src/_data/team.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,24 @@
"photo": "https://www.a11yproject.com/img/team/eric-bailey.jpg",
"biography": "I help create straightforward solutions that address a person’s practical, physical, cognitive, and emotional needs using accessible, performant, device-agnostic technology."
},
{
"name": "Jen Downs",
"website": "https://jen.dev",
"photo": "https://www.a11yproject.com/img/team/jen-downs.jpg",
"biography": "Jen is a developer who loves building accessible user interfaces and JavaScript applications, skateboarding, and playing video games."
},
{
"name": "Jerry Jones",
"website": "https://jeremyjon.es/",
"photo": "https://www.a11yproject.com/img/team/jerry-jones.jpg",
"biography": "I’m a generalist web developer at Automattic living simply in rural Missouri with my wife and three kids."
},
{
"name": "Saptak Sengupta",
"website": "https://saptaks.website",
"photo": "https://www.a11yproject.com/img/team/saptaks.jpg",
"biography": "Saptak is a web developer trying to contribute in making websites more accessible, inclusive and privacy focused"
},
{
"name": "Scott Vinkle",
"website": "https://scottvinkle.me/",
Expand All @@ -56,18 +68,6 @@
"photo": "https://www.a11yproject.com/img/team/wayne-elgin.jpg",
"biography": "Wayne is a jack-of-many-trades developer, especially UX web technologies. He's been making websites since 1997. He values clean, semantic markup paired with creative, accessible styles. He likes Marx Brothers movies and biking with his kids."
},
{
"name": "Jen Downs",
"website": "https://jen.dev",
"photo": "https://www.a11yproject.com/img/team/jen-downs.jpg",
"biography": "Jen is a developer who loves building accessible user interfaces and JavaScript applications, skateboarding, and playing video games."
},
{
"name": "Saptak Sengupta",
"website": "https://saptaks.website",
"photo": "https://www.a11yproject.com/img/team/saptaks.jpg",
"biography": "Saptak is a web developer trying to contribute in making websites more accessible, inclusive and privacy focused"
},
{
"name": "…and maybe you!",
"website": "/contribute/",
Expand Down
2 changes: 1 addition & 1 deletion src/_includes/checklist.njk
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
name="{{ checklist.checkboxId }}"
id="{{ checklist.checkboxId }}">
<label for="{{ checklist.checkboxId }}">
<span class="u-hide-visually">Mark “{{ checklist.title | safe }}” as complete</span>
<span class="u-hide-visually">Task: {{ checklist.title | safe }}</span>
</label>
</div>

Expand Down
2 changes: 1 addition & 1 deletion src/css/base/_code.scss
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var {
// Initial styles applied to the `code` element without a class applied to it.
//
// Markup:
// <code>npm run a11yproject</code>
// <code>npm start</code>
//
// Styleguide Base.Code.code

Expand Down

0 comments on commit 722b92b

Please sign in to comment.