-
Notifications
You must be signed in to change notification settings - Fork 236
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
Adds documentation for upgrading the kit via the command line #219
Conversation
@@ -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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
this is good work, and important as we don't have any instructions on what to do in the case of changes to |
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. |
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? |
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? |
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 |
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 ( |
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 |
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?
|
@joelanman Good points. Changes made. |
thanks @paulmsmith 🍰 |
Adds documentation for upgrading kits via the command line with git. Thoughts? Please check and proof read.