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 instructions for installation on NHS England machines #68

Merged
merged 10 commits into from
Nov 4, 2024

Conversation

frankieroberto
Copy link
Contributor

@frankieroberto frankieroberto commented Nov 2, 2024

Adds specific instructions for users of NHS England managed Windows laptops, given that these are a core user group.

Based on the content from the internal guide.

Fixes #8.

Not quite sure how best to link this in with the existing installation instructions for Windows and general guide. Have added a link from the Get started page for now but open to better ideas!

➡️ Preview here: https://nhs-prototyp-add-nhs-en-stqwjl.herokuapp.com/install/nhs-england-windows-laptops

@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 2, 2024 23:07 Inactive
@frankieroberto
Copy link
Contributor Author

@paulmsmith did these instructions work for you? Anything to add?


<h2 class="nhsuk-heading-m">Install software dependencies</h2>

<p>The following can be installed from the Company Portal application:</p>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure where this application actually lives? Is it a web-based thing we could link to, or some kind of app buried in the start menu?


<ul>
<li>Terminal</li>
<li>Visual Studio Code</li>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if it’s called Visual Studio Code or VS Code within the Company Portal application - we should check.

@vickytnz vickytnz temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 00:35 Inactive
@vickytnz vickytnz temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 00:46 Inactive
Copy link
Contributor

@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.

Suggestion

I think that this can be made up of a:

  1. Page that is a NHSE Windows 'before step'
  2. Callout for NHSE Windows used across multiple pages

1. Page that is a NHSE Windows 'before step'

NHSE England only page with before sections

This positions the page as a before step

2. Callout for NHSE Windows used across multiple pages

There is a common inset text:

If you are using an NHS England Windows laptop, you must do some extra steps for NHS England Windows laptops before you start

This is used on the:

  • install guide - which has also been restructured with extra headings to put this between the overall instructions and the start now action link
  • advanced install guide
  • switching from the GOV.UK prototype kit guide
Install guide Advanced Switching
install guide with headings for problems and other ways to install and linking to NHS Windows setup steps advanced install guide with inset text linking to NHS Windows setup steps switching from the GOV.UK Prototype Kit guide with inset text linking to NHS Windows setup steps

Earlier commits

Something that I found from working through the installation instructions with caroline was that people very much just work down the page so they may miss the windows instructions unless there's some form of course correct in the instructions.

I don't have enough information to quite know what the answer is, but I think that the simple install page can more for the initial 'you need to do some things first'.

How prominent this is may depend on how many people are going to be this user group and from this how much you want to foreground these details - the 4 options I show play with different options (I am maybe erring towards the callout on a page and then still having the existing page but maybe making it being clearly about the 2 setup steps?).

I also wonder if the ordering is off in that getting the folder sorted is mission critical and then install software knowing what path to use?

Simple and restructured (latest pull) Short link and callout Header and expanders Large callout
version restructuring page order version with short link and callout to page version with header and expanders version with large callout

There is also an opportunity to weave it into other pages

Inset text (latest pull) Callout
advanced page with inset text advanced page with callout to main page

@vickytnz vickytnz temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 01:27 Inactive
@vickytnz vickytnz temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 02:06 Inactive
* Fixed a couple of formatting mistakes
* added inset text link to NHSE WIndows laptop page to switching page
* changed inset text to a macros on the NHSE Windows laptop page that can be reused on advanced, simple, and switching page for consistency
@vickytnz vickytnz temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 09:20 Inactive
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 21:08 Inactive
I think a Nunjucks `includes` is a simpler option here, as there are no params being set in the macro.

Also switched to use the `insetText` macro instead of HTML, and reduced the padding and margins a bit.

Tweaked the wording in the inset text to remove the repetition of "NHS England Windows laptop".
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-add-nhs-en-stqwjl November 3, 2024 21:22 Inactive
@frankieroberto
Copy link
Contributor Author

@vickytnz nice. I think the inset text is better than the warning callout, which is maybe a bit much. It could perhaps even work as a plain paragraph (people sometimes ignore inset text as it can be over-used), but I've kept it as inset text for now.

Tweaked the wording and whitespace slightly in 823e94d - and also switched to using an include instead of a custom macro.

@frankieroberto frankieroberto merged commit b8c8f7b into main Nov 4, 2024
3 checks passed
@frankieroberto frankieroberto deleted the add-nhs-england-install-instructions branch November 4, 2024 09:44
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.

Reference instructions for installing on NHS corporate laptops.
2 participants