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

Consolidating guidance for text editors #132

Conversation

vickytnz
Copy link
Contributor

Building on earlier notes to remove mention to Atom and building on it.

Done in this ticket:

  • removed the 1 remaining reference to Atom because it is now not actively in development
  • removed 1 mention to Notepad++ for Windows as it was inconsistently recommended between the install guidance and building a basic prototype
  • documented and created a consistent way to introduce Visual Studio Code (full name and then shortcut), and describe its benefits (keeping a particular note from the GOV.UK Prototype Kit guidance about accessibility)

You'll also need a code editor. Any HTML text editor will do, but we recommend Visual Studio Code (also known as VS Code). This is because it is free, fairly accessible, and has lots of useful features.

Before After
windows - choose text editor, mentions visual studio code as free windows - choose text editor, mentions visual studio code with other name and changes
mac - choose text editor, mentions visual studio code as free mac - choose text editor, mentions visual studio code with other name and changes
start make prototype with both VS Code and Notepad++ as options start make prototype with Visual Studio Code as only option

I also found an orphan page 'requirements' - i have changed it for now but will make a separate ticket to remove it

Before After
requirements page mentioning atom requirements page mentioning vs code

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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.

I wonder if we need “fairly accessible”? Sounds a bit of a weasel word phrase and might be hard to assess long-term?

@vickytnz
Copy link
Contributor Author

I wonder if we need “fairly accessible”? Sounds a bit of a weasel word phrase and might be hard to assess long-term?

yeah I did wonder about that - though that is how it is phrased in the gov.uk prototype kit! https://prototype-kit.service.gov.uk/docs/install/requirements-mac

Co-authored-by: Frankie Roberto <[email protected]>
@vickytnz vickytnz temporarily deployed to nhs-prototyp-97-referen-u4eyg3 November 19, 2024 17:14 Inactive
@vickytnz vickytnz temporarily deployed to nhs-prototyp-97-referen-u4eyg3 November 19, 2024 17:16 Inactive
@vickytnz
Copy link
Contributor Author

You'll also need a code editor. Any HTML text editor will do, but we recommend Visual Studio Code (also known as VS Code). This is because it is free and has lots of useful features.

@vickytnz vickytnz temporarily deployed to nhs-prototyp-97-referen-u4eyg3 November 19, 2024 17:41 Inactive
@vickytnz vickytnz merged commit aef9c44 into main Nov 19, 2024
4 checks passed
@vickytnz vickytnz deleted the 97-reference-vs-code-alongside-atom-in-install-guide-in-prototype-kit branch November 19, 2024 18:05
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 VS Code alongside Atom in install guide in prototype kit
2 participants