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

Update README #371

Merged
merged 2 commits into from
Apr 12, 2017
Merged

Update README #371

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ceb1d9
Update README
joelanman Apr 11, 2017
fe12e1e
bring back installation links
joelanman Apr 12, 2017
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
24 changes: 1 addition & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# GOV.UK Prototype kit

## News

**Upgrading from version 1 to 2:** the latest version of the kit (2.0.0 and later) is not compatible with previous versions. If you update your old prototypes you'll need to [convert them as well](https://govuk-prototype-kit.herokuapp.com/docs/updating-the-kit).
Go to the [GOV.UK Prototype Kit site](https://govuk-prototype-kit.herokuapp.com/docs) to download the latest version and read the documentation.

## About the prototype kit
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd delete the line about project principles.

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's the only place it's linked to, so I'd like to keep it for now.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't personally see the relevance to linking to them here. But I don't feel strongly about it.


Expand All @@ -16,26 +14,6 @@ If you publish your prototypes online, they **must** be protected by a [username

You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like GOV.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.

## Installation instructions
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like it's still valuable to link to the install instructions.

It's somewhat odd we don't have basic instructions for minimal install - eg npm install, npm start. I feel like most repos I come across contain a minimal set of instructions for running locally - without needing to go online to find out how.


- [Installation guide for new users (non technical)](https://govuk-prototype-kit.herokuapp.com/docs/install/introduction)
- [Installation guide for developers (technical)](https://govuk-prototype-kit.herokuapp.com/docs/install/developer-install-instructions)

## Guides

1. [Setting up git](https://govuk-prototype-kit.herokuapp.com/docs/setting-up-git)
2. [Publishing on the web (Heroku)](https://govuk-prototype-kit.herokuapp.com/docs/publishing-on-heroku)
3. [Using GOV.UK Verify](https://govuk-prototype-kit.herokuapp.com/docs/using-verify)

## Other documentation

- [Prototype kit principles](https://govuk-prototype-kit.herokuapp.com/docs/principles)
- [Making pages](https://govuk-prototype-kit.herokuapp.com/docs/making-pages)
- [Writing CSS](https://govuk-prototype-kit.herokuapp.com/docs/writing-css)
- [Updating the kit to the latest version](https://govuk-prototype-kit.herokuapp.com/docs/updating-the-kit)
- [Tips and tricks](https://govuk-prototype-kit.herokuapp.com/docs/tips-and-tricks)
- [Creating routes (server-side programming)](https://govuk-prototype-kit.herokuapp.com/docs/creating-routes)

## Community

We have two Slack channels for the Prototype kit. You'll need a government email address to join them.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link directly to the cross government slack here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

whats the problem?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not very helpful - it doesn't tell people where to find the channels. We can point them at the url to join slack.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It links directly to the channels?

Copy link
Contributor

Choose a reason for hiding this comment

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

Where? I don't see any links?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oops sorry, Github had collapsed the links. Nothing to see here.

Expand Down