Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation update #160

Merged
merged 4 commits into from
Mar 2, 2016
Merged

Minor documentation update #160

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0611914
Fix typo and add note about warnings
edwardhorsford Mar 1, 2016
9ee1f34
Make link to running kit open in new window
edwardhorsford Mar 1, 2016
9046989
Fix typo
edwardhorsford Mar 2, 2016
a3d1714
Make text about new tab visible to everyone
edwardhorsford Mar 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/install/install-the-kit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Unzip the kit you downloaded - you should end up with a folder called `govuk_pro

### Rename the kit

Rename the folder to something descriptive for your prototype. For this guide, we’ll use `juggling-licence-prototype`.
Rename the folder to something descriptive for your prototype. For this guide, we’ll use `juggling-license-prototype`.

### Move the kit in to projects folder

Expand Down Expand Up @@ -85,7 +85,7 @@ You need to download extra code used by the kit before it can run. You can get t
```
npm install
```
The install may take up to a minute.
The install may take up to a minute. Whilst installing it may `WARN` about some items - this is ok. As long as there are no `ERROR`s you can continue.

---
[Previous page (requirements)](requirements.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/install/run-the-kit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Listening on port 3000 url: http://localhost:3000

## Check it works

In your web browser, visit [http://localhost:3000](http://localhost:3000)
In your web browser, visit <a href="http://localhost:3000" target="_blank">http://localhost:3000<span class="visuallyHidden"> (opens in a new window)</span></a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't think this needs a new window?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it does. I observed a user yesterday follow the link from the docs, thereby loosing the documentation which has more to say - and in the future might have 'next steps'. Better to open in a new window IMHO.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they didnt know to click back? I've seen more issues with people getting lost with new windows - you can't click back, theres no obvious thing to do to get back

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think they're rather likely to want both open simultaneously. So they can play about with the kit whilst reading the docs.

These are also likely to be designers / people working on the kit - I am assuming that most of our users are likely to be able to handle different tabs, etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, but I think the warning is useful to all users, not just screen readers. And should it be "opens in a new tab"?


You should see the prototype welcome page.

Expand Down