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

Add tutorial for creating a basic prototype (based on GOV.UK one) #20

Merged
merged 36 commits into from
Nov 2, 2024

Conversation

vickytnz
Copy link
Contributor

@vickytnz vickytnz commented Oct 20, 2024

Description

This is probably not quite ready to go straight to deployment because it has:

  1. example pages to help with debugging or screenshots - these probably need to be deleted
  2. a nunjucks base page with variables to help with change pages before it is resolved
  3. code formatting that could be tidier
  4. a few little elements of the nhs components that aren't yet in the code (for example, deleting the paragraph at the bottom of each template page that links to the templates)

It does have a full worked example bringing together the content into a guide.

Example of translated screenshots that are used in the examples

overview of new screens
new magical powers screen
new details screen

It's also shown that some of the design system components can do with tweaking, for example:

  1. radio examples don't have the same text in the text as the variable
  2. radio example in component library starts with yes/no, unlike govuk design system which starts with list of 3
  3. textarea component doesn't have headers shown

Checklist

  • Tested against our testing policy (Resolution, Browser & Accessibility)
  • CHANGELOG entry

Resolves #17

@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 20, 2024 19:17 Inactive
Copy link
Contributor

@frankieroberto frankieroberto left a comment

Choose a reason for hiding this comment

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

A great start!

I think we’ll need to add some css for code blocks and inline code examples as those are currently quite hard to spot (just the font changes).

app/views/how-tos/make-first-prototype/start.html Outdated Show resolved Hide resolved
app/views/how-tos/make-first-prototype/start.html Outdated Show resolved Hide resolved
app/views/how-tos/make-first-prototype/start.html Outdated Show resolved Hide resolved
app/views/how-tos/make-first-prototype/start.html Outdated Show resolved Hide resolved
app/views/how-tos/make-first-prototype/create-pages.html Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Presumably these pages should be deleted before we merge, and just used to test it out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep, exactly, it's particularly since we're using code examples and also doing screenshots - this makes it easier to debug (I also realise i haven't tested the branching)

app/config.js Outdated Show resolved Hide resolved
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 21, 2024 15:44 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 21, 2024 15:45 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 21, 2024 15:46 Inactive
Copy link
Contributor Author

@vickytnz vickytnz left a comment

Choose a reason for hiding this comment

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

Changes made base on Frankie's comments

Copy link
Contributor

@frankieroberto frankieroberto left a comment

Choose a reason for hiding this comment

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

Looking good!

Would you mind doing indenting on all the nested HTML just to make it easier to read? A code formatter like prettier should be able to do it for you automatically.

Also the files used to test the tutorial itself (magical-powers.html etc) should all be deleted.

Then perhaps we get another pair of eyes on it (@edwardhorsford?), and see if we can find someone to test it by actually following the tutorial?

app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/index.html Outdated Show resolved Hide resolved
app/views/how-tos/make-first-prototype/branching.html Outdated Show resolved Hide resolved
app/views/content-page.html Outdated Show resolved Hide resolved
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 14:53 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 15:14 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 15:48 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 16:29 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 16:34 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 16:37 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 16:40 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 26, 2024 16:40 Inactive
@vickytnz
Copy link
Contributor Author

Current status is that this is in a good place for review:

  • there may be a few little code things with styling that aren't 100% with the GOV.UK version (whether things are styled as code or strong etc)
  • I've removed the example pages but deliberately left all the new content as variables in the base page just to make sure any changes happen across all pages - it could be that they can be hard-coded but it was so tricky to find everything that I don't want to remove them just yet

@frankieroberto frankieroberto dismissed their stale review October 26, 2024 22:24

Suggestions addressed

app/config.js Outdated Show resolved Hide resolved
@frankieroberto frankieroberto changed the title New version of screens based on GOV.UK version Add tutorial for creating a basic prototype (based on GOV.UK one) Oct 26, 2024
Co-authored-by: Frankie Roberto <[email protected]>
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-nhs-simple-vpgjbf October 27, 2024 17:13 Inactive
@vickytnz
Copy link
Contributor Author

vickytnz commented Nov 2, 2024

Need to link from the install guide - will make separate pull request.

@vickytnz vickytnz merged commit e95d0be into main Nov 2, 2024
2 checks passed
@vickytnz vickytnz deleted the nhs-simple-tutorial branch November 2, 2024 16:08
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.

Add a tutorial showing how to create a basic service prototype
2 participants