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.

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

Adds documentation for upgrading the kit via the command line #219

Merged
merged 8 commits into from
Aug 16, 2016
Merged

Adds documentation for upgrading the kit via the command line #219

merged 8 commits into from
Aug 16, 2016

Conversation

paulmsmith
Copy link
Contributor

Adds documentation for upgrading kits via the command line with git. Thoughts? Please check and proof read.

@@ -1,17 +1,96 @@
# Updating the kit

There are two ways you could upgrade the prototype kit. If you're confident in your use of the command line interface such as terminal then read the 'Upgrading via the command line' instructions. If you'd prefer not to or are not using the command line to manage your prototype then read the 'Upgrading manually' instructions.
Copy link
Contributor

Choose a reason for hiding this comment

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

We've changed from 'updating' to 'upgrading' - probably best to stick to one throughout

Copy link
Contributor

Choose a reason for hiding this comment

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

Elsewhere, we assume our primary user is someone who does not have technical experience - so I think we should do that here too and mention the manual instructions first as the common case.

@joelanman
Copy link
Contributor

this is good work, and important as we don't have any instructions on what to do in the case of changes to /app. I think it's important to do some quick user research on this - ideally put it in front of a less confident, and a more confident user, and see if they can follow it. Would that be possible?

@paulmsmith
Copy link
Contributor Author

paulmsmith commented Jun 27, 2016

I can find a few users of the kit in DWP that will be on 2.X release of the kit. I'll observe and see if there are any scenarios not covered in what I've written. Let's leave this PR open until I can report back.

@paulmsmith
Copy link
Contributor Author

Made the changes based on your initial feedback @joelanman. Will see if I can get this tested by some appropriate users. Maybe you or others can too?

@paulmsmith
Copy link
Contributor Author

Had a user with low confidence follow these, they were fine until merge conflicts. Initial fear replaced by 'I want to learn how to deal with this'. Maybe guidance around merge conflicts could be added?

@joelanman
Copy link
Contributor

with the less confident user, did they understand that there was a more basic version for them to follow, and the advanced section was advanced? I'm not so worried if they can't actually follow all the advanced process

@paulmsmith
Copy link
Contributor Author

paulmsmith commented Jul 26, 2016

I asked them to read the documentation for updating their prototype. Initial action was to update the manual way and that would have been the way they chose. Upgraded via the advanced method to see at what point they struggled, if at all. Only struggled when presented with merge conflicts, resolved them but with some struggle due to lack of visual diff tool and understanding around 'resolving' conflicts.

They read the github docs I've provided a link to but slightly misinterpreted the conflict markers (>>>>>>>>) which is a typical inexperienced user's issue with git conflicts.

@joelanman
Copy link
Contributor

nice work, in that case I'll try and get another pair of eyes on it tomorrow and see if we can get it merged

@joelanman
Copy link
Contributor

many apologies for leaving this so long - couple of things:

Can we stick to 'Update' or 'Upgrade' throughout? NPM refers to update, so maybe that?

also I'm not sure if this line is useful?

The steps below 'Upgrading' describe how to upgrade to the latest release of prototype kit.

@paulmsmith
Copy link
Contributor Author

@joelanman Good points. Changes made.

@joelanman joelanman merged commit 1f52095 into alphagov:master Aug 16, 2016
@joelanman
Copy link
Contributor

thanks @paulmsmith 🍰

@paulmsmith paulmsmith deleted the feature/addition-to-upgrading-documentation branch December 26, 2016 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants