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

Add missing detail to Updating the Kit Documentation #286

Closed
wants to merge 1 commit into from
Closed

Add missing detail to Updating the Kit Documentation #286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions docs/documentation/updating-the-kit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,26 @@ git checkout master && git merge FETCH_HEAD

You shouldn't have any merge conflicts if you've not changed files outside of the 'app' folder. If you do, there are plenty of ways to fix the conflicts and [github has instructions](https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line/) that should be easy to follow if you need a refresher course.

Finally, after updating the kit it's time to start the application just to test that everything went smoothly. In terminal or command prompt type:

```
npm start
```

All being well the prototyping kit application will run as normal. If you see an error after updating, there may have been changes to underlying code that require an extra command to be run before you can start the application. Type the following into your terminal or command prompt:
Copy link
Contributor

@gemmaleigh gemmaleigh Oct 14, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

I think it would be good if this is consistent with the instructions already in the docs:

install/install-the-kit.md
install/run-the-kit.md

In terminal:

npm start

After the kit has started, you should see a message telling you that the kit is running:

Listening on port 3000 url: http://localhost:3000

If you see an error after updating, you may need to download extra code used by the kit before it can run.

You can get this by running:

npm install

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 ERRORs you can continue.

In terminal:

npm start

After the kit has started, you should see a message telling you that the kit is running:

Listening on port 3000 url: http://localhost:3000

If you still have an error, you can raise an issue within github or ask in the Slack channel for users of the prototype kit.

Try to provide as much information as you can about the error and the computer you are attempting to run the prototyping kit on.

Copy link
Contributor

Choose a reason for hiding this comment

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

cc. @edwardhorsford as I'm copy-and-pasting your docs 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.

Better to repeat that in context with the upgrade docs or link to it from the documentation I've written?

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 think its easy to link to this content as it stands, so yeh just copying and pasting for consistency would be good.

I don't think we need the second instance of:

After the kit has started, you should see a message telling you that the kit is running:

Listening on port 3000 url: http://localhost:3000

as we've just said that above


```
npm install
```

You will most likely see a progress indication of various pieces of newer code being installed. When it's finished you will be returned to the command prompt and should be able to start the prototyping kit with the previous command:

```
npm start
```

Running the install command will fix the majority of errors after updating the kit. If you still have an error, you can [raise an issue within github](https://github.com/alphagov/govuk_prototype_kit/issues) or ask in the [Slack channel for users of the prototype kit](https://ukgovernmentdigital.slack.com/messages/prototype-kit/) by providing as much information as you can about the error and the computer you are attempting to run the prototyping kit on.

---

## Converting old prototypes
Expand Down