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

Adding information about using GitHub and GitHub Desktop #168

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

vickytnz
Copy link
Contributor

@vickytnz vickytnz commented Dec 4, 2024

Ported over the GOV.UK Prototype Kit guides:

  1. Store your code online with GitHub and GitHub Desktop
  2. Store your new prototype in GitHub
  3. Download an existing prototype from GitHub4. Collaborate on prototypes using GitHub Desktop

Reformatted the guides page to have a section.

I do wonder if it would be better to reconfigure the install section to just be about Github or somehow pull the downloading someone else's prototype earlier with an easier through-line.

This could also align with @paulmsmith's work on Codespaces.

Pages:

How to (changed to 3 columns) and with some new ideas

Guides page with section 'Version control and collaboration' with pages 'Store your code online with GitHub and GitHub Desktop', 'Store your new prototype in GitHub', 'Download an existing prototype from GitHub', 'Collaborate on prototypes using GitHub Desktop'

Store your code online with GitHub and GitHub Desktop

Store your code online with GitHub and GitHub Desktop page

Store your new prototype in GitHub

Store your new prototype in GitHub page

Download an existing prototype from GitHub

Download an existing prototype from GitHub

Collaborate on prototypes using GitHub Desktop

Collaborate on prototypes using GitHub Desktop page

Ported over the GOV.UK Prototype Kit guides:
1. Store your code online with GitHub and GitHub Desktop
2. Store your new prototype in GitHub
3. Download an existing prototype from GitHub4.
Collaborate on prototypes using GitHub Desktop

Reformatted the guides page to have a section.
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 4, 2024 23:48 Inactive
@vickytnz
Copy link
Contributor Author

vickytnz commented Dec 5, 2024

I'm also now wondering how much this needs to be "NHSed" to at least note that this should usually be done with official NHS repositories and with our processes. DfE does similar with their guidance for design ops

https://design.education.gov.uk/design-system/github-heroku

@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 5, 2024 22:16 Inactive
@vickytnz
Copy link
Contributor Author

vickytnz commented Dec 5, 2024

Version now ready for review

How to page with new section

How to with Storing and sharing code, Store your code online with GitHub and GitHub Desktop, Using GitHub if you work for NHS England, Store your new prototype in GitHub, Download an existing prototype from GitHub, Collaborate on prototypes using GitHub Desktop, Setting up Git using the terminal

Store your code online with GitHub and GitHub Desktop

Similar to GOV.UK page but some tweaking and addition of NHS England info and a course correct to start with installing as needed
Store your code online with GitHub and GitHub Desktop

Using GitHub if you work for NHS England

NEW PAGEThis is trying to have just enough information without duplicating stuff that is in Sharepoint organisations. Main thing is to encourage people to set up Github early rather than go rogue.
Using GitHub if you work for NHS England

Store your new prototype in GitHub

As per the GOV.UK version with extra linking to other sections.
Store your new prototype in GitHub

Download an existing prototype from GitHub

As per the GOV.UK version with extra linking to other sections.
Download an existing prototype from GitHub

Collaborate on prototypes using GitHub Desktop

As per the GOV.UK version. This hasn't been changed.
Collaborate on prototypes using GitHub Desktop

@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 5, 2024 22:28 Inactive
@vickytnz vickytnz marked this pull request as ready for review December 5, 2024 22:29
@vickytnz vickytnz changed the title First version of adding collaboration section Adding information about using GitHub and GitHub Desktop Dec 5, 2024
app/views/how-tos/github/collaborate.html Outdated Show resolved Hide resolved
app/views/how-tos/github/download-existing-prototype.html Outdated Show resolved Hide resolved
app/views/how-tos/github/index.html Outdated Show resolved Hide resolved
app/views/how-tos/github/nhs-england.html Outdated Show resolved Hide resolved
app/views/how-tos/github/store-new-prototype.html Outdated Show resolved Hide resolved
app/views/how-tos/github/store-new-prototype.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 7, 2024 17:15 Inactive
@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 7, 2024 17:30 Inactive
@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 7, 2024 17:37 Inactive
@vickytnz
Copy link
Contributor Author

vickytnz commented Dec 7, 2024

Latest version included comment fixes but also uses the 'mini-hub component. This makes it easier to see the steps (though it does make me wonder if the NHS England one is in the right place)

Set up GitHub and GitHub Desktop with mini-hub layout

Using GitHub if you work for NHS England

Store your new prototype online

Download an existing prototype

Collaborate on a prototype

Two things I am considering:

  1. I'm not entirely sure about the split on the first few pages. Maybe the first page should be Overview with just the concepts and even have a separate page just about creating a GitHub account which could then allow for all the NHS England information to go there?
  2. I have also noticed that this pattern is different from the one for the basic prototype which is more like a transactional thing (namely the title hint has switched from above to below) - not sure if this needs to get fixed

@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 7, 2024 21:33 Inactive
@vickytnz vickytnz temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 7, 2024 21:45 Inactive
@vickytnz
Copy link
Contributor Author

vickytnz commented Dec 7, 2024

After more reviews I've done a complete redo to:

Redo the how-to page

Storing and sharing code
Store your code online with GitHub and GitHub Desktop
Set up GitHub and GitHub Desktop
Store a new prototype in GitHub
Download an existing prototype from GitHub
Collaborate on prototypes using GitHub Desktop
Set up Git using the terminal

Overview page (new)

This is now just about the basic stuff but also links over to the git terminal information
page with concepts and redirect to git on terminal

Set up GitHub and GitHub Desktop

This page:

  • takes what was the second part of the initial setup page
  • added details about installing git as that was missing (PS I hope these instructions work)
  • merges the NHS England stuff and cuts it down a lot (I've removed stuff about other orgs and other repos)

set up page with install git, get github account, and download and setup github desktop

Store a new prototype on GitHub

This page adds course corrects to other starting points (new prototype and the github setup)

store a new prototype on GitHub page

Download an existing prototype from GitHub

Linking to previous pages

Download an existing prototype from GitHub page

Collaborate on a prototype

Collaborate on a prototype

Only remaining things for me are:

  • consistency of titles (maybe it's overkill on the Github stuff and titles could be just 'Download an existing prototype' etc)
  • overall consistency of titles with other sections (e.g. the subheader is different here to the basic prototype)

@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-167-port-g-4zivqt December 12, 2024 15:48 Inactive
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.

Port GOV.UK Prototype Kit guides for Github Desktop collaboration to our site
4 participants