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

Rename 'How to guides' as 'Guides' #117

Merged
merged 1 commit into from
Nov 18, 2024
Merged

Conversation

frankieroberto
Copy link
Contributor

This is a proposal - would be interested to see what others think! Rationale below.


This renames the 'How to guides' as simply 'Guides'.

This is because:

  • 'How to guides' is an awkward phrase to read, as you. might initially assume the third word is a verb (like "How to code" and then have to re-evaluate it as a noun phrase
  • It’s longer than it needs to be, and we might want to have a navigation bar at some point, in which case 'Guides' would be a lot shorter

In addition, some of the guides themselves (which had a mixture of forms) have been renamed to no longer include 'How to'. This also means the link text on the index page now matches the titles when you click through.

They all now start with a verb (although a mix of tenses).

The changes are:

  • How to setup Git -> Setting up Git
  • How to use components -> Using components
  • How to do branching -> Branching
  • How to make pages -> Making pages
  • How to pass data page to page -> Passing data page to page

The other guide titles are unchanged:

  • Build a basic prototype using the NHS.UK prototype kit
  • Adding CSS, JavaScript and Images
  • Updating the kit
  • Switching from the GOV.UK prototype kit

The breadcrumb is also changed from "How to guides" to just "Guides"

This renames the 'How to guides' as simply 'Guides'.

This is because:

* 'How to guides' is an awkward phrase to read, as you. might initially assume the third word is a verb (like "How to code" and then have to re-evaluate it as a noun phrase
* It’s longer than it needs to be, and we might want to have a navigation bar at some point, in which case 'Guides' would be a lot shorter

In addition, some of the guides themselves (which had a mixture of forms) have been renamed to no longer include 'How to'. This also means the link text on the index page now matches the titles when you click through.

They all now start with a verb (although a mix of tenses).

The changes are:

* How to setup Git -> Setting up Git
* How to use components -> Using components
* How to do branching -> Branching
* How to make pages -> Making pages
* How to pass data page to page -> Passing data page to page

The other guide titles are unchanged:

* Build a basic prototype using the NHS.UK prototype kit
* Adding CSS, JavaScript and Images
* Updating the kit
* Switching from the GOV.UK prototype kit

The breadcrumb is also changed from "How to guides" to just "Guides"
@frankieroberto frankieroberto temporarily deployed to nhs-prototyp-rename-how-iatrf0 November 17, 2024 21:37 Inactive
@frankieroberto frankieroberto merged commit 4221180 into main Nov 18, 2024
4 checks passed
@frankieroberto frankieroberto deleted the rename-how-to-guides branch November 18, 2024 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants