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 info on default components in page template #2173

Merged
merged 1 commit into from
Jun 7, 2022

Conversation

EoinShaughnessy
Copy link
Contributor

Fixes #2162.

Updates these guidance pages:

  • Footer
  • Header
  • Page template
  • Skip link

Reason for update

The footer, header and skip link guidance pages do not tell users that the page template includes these components by default. This might have led some users to think they had no option but to add the components themselves.

We're also updating the page template guidance to explain how users can customise these components. However, our hope is that users will stick with the template once they're aware it exists.

@netlify
Copy link

netlify bot commented May 4, 2022

You can preview this change here:

Name Link
🔨 Latest commit 0642b7f
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/628e5c50f035490008145ed2
😎 Deploy Preview https://deploy-preview-2173--govuk-design-system-preview.netlify.app/community/design-system-working-group
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@EoinShaughnessy EoinShaughnessy force-pushed the iterate-pagetemplate-skiplink-header-footer branch from a3132d6 to 1390779 Compare May 5, 2022 10:10
@EoinShaughnessy EoinShaughnessy marked this pull request as draft May 11, 2022 07:29
@EoinShaughnessy EoinShaughnessy marked this pull request as ready for review May 11, 2022 07:29
@EoinShaughnessy EoinShaughnessy marked this pull request as draft May 23, 2022 13:19
@EoinShaughnessy EoinShaughnessy marked this pull request as ready for review May 23, 2022 13:19
@EoinShaughnessy
Copy link
Contributor Author

@36degrees Can I get a review? :)

@36degrees
Copy link
Contributor

Catching up with @EoinShaughnessy tomorrow to talk through the page template guidance as I think there's some overlap with some of the existing content that needs resolving.

@EoinShaughnessy EoinShaughnessy force-pushed the iterate-pagetemplate-skiplink-header-footer branch from 8ebd1aa to 4ff2e12 Compare May 25, 2022 16:01
@EoinShaughnessy EoinShaughnessy marked this pull request as draft May 25, 2022 16:09
@EoinShaughnessy EoinShaughnessy marked this pull request as ready for review May 25, 2022 16:09
@EoinShaughnessy EoinShaughnessy force-pushed the iterate-pagetemplate-skiplink-header-footer branch from 1f2e758 to dd8b71a Compare May 25, 2022 16:29
@EoinShaughnessy EoinShaughnessy force-pushed the iterate-pagetemplate-skiplink-header-footer branch from d3c7b36 to 0642b7f Compare May 25, 2022 16:41
@@ -13,6 +13,8 @@ The footer provides copyright, licensing and other information about your servic

{{ example({group: "components", item: "footer", example: "default", id: "default-1", html: true, nunjucks: true, open: false, size: "m"}) }}

If you use the page template, you'll also get the footer without having to add it, as it's included by default. However, if you want to customise the default footer, read the [page template guidance about customising components](/styles/page-template/#changing-template-content).
Copy link
Contributor

@domoscargin domoscargin May 31, 2022

Choose a reason for hiding this comment

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

I think a lot of people come straight into the "components" section and might not know where to go to get the Page Template info (my instinct was "patterns", not "styles").

I wonder if people will read the first part of this and gloss over the second part because of the "however", and thus not be able to find the page template guidance.

I might be overthinking, and looking through the comments, it looks like this has been discussed already.

@domoscargin
Copy link
Contributor

I think this looks OK from a dev perspective. Just a minor comment. Looks fine to merge before starting on #2203.

@calvin-lau-sig7 calvin-lau-sig7 merged commit e01cebf into main Jun 7, 2022
@calvin-lau-sig7 calvin-lau-sig7 deleted the iterate-pagetemplate-skiplink-header-footer branch June 7, 2022 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants