Update links to Design System from READMEs #528
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-528
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-528
NickColley
reviewed
Feb 13, 2018
app/views/layouts/component.njk
Outdated
| <h2 class="govuk-heading-l">Guidance</h2> | ||
| <p class="govuk-body"> | ||
| More information about when to use {{ componentName }} can be found on <a href="{{- componentGuidanceLink -}}" title="Link to read guidance on the use of {{ componentName }} on Gov.uk Design system website" class="govuk-link">GOV.UK Design System</a> | ||
| More information about when to use {{ componentName }} can be found on <a href="{{- componentGuidanceLink -}}" title="Guidance on the use of {{ componentName | replace("-", " ") | capitalize }} on GOV.UK Design System" class="govuk-link">GOV.UK Design System</a>. |
There was a problem hiding this comment.
Should we be using title here? It doesn't improve accessibility as far as I understood?
https://silktide.com/i-thought-title-text-improved-accessibility-i-was-wrong/
This was referenced Feb 14, 2018
alex-ju
approved these changes
Feb 14, 2018
There was a problem hiding this comment.
@NickColley's point seem valid to me. otherwise good to be merged.
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-528
36degrees
force-pushed
the
update-links-to-design-system
branch
from
7ae07f3 to
4fbdcd0
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-528
|
@NickColley I've talked to Amy and she's requested some copy changes which I've made, removing the title attribute in the process. |
Replace the placeholder links (http://www.linktodesignsystem.com) with links to the current private beta production Design System (https://govuk-design-system-production.cloudapps.digital)
The Design System does not have any guidance for the label component, as the label component is only a component because it provides a way to avoid repetition between components, and as such does not need documenting.
There is currently a discrepancy between the Design System and Frontend on the name of this component – until this is resolved, we’ll need to manually override the link so that it points to the right place.
Remove the title text from the link to the Design System, as title attributes don't actually improve accessibility [1]. Update the copy as agreed with @amyhupe, to make sure users understand that they are going to go to the Design System and to help them to understand what the Design System will tell them that the README doesn't. [1]: https://silktide.com/i-thought-title-text-improved-accessibility-i-was-wrong/
36degrees
force-pushed
the
update-links-to-design-system
branch
from
4fbdcd0 to
df331d7
Compare
NickColley
approved these changes
Feb 15, 2018
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the links from each component README to the relevant page in the current private-alpha 'production' Design System.
Remove the link to guidance from the label component, which does not have corresponding guidance in the Design System.
Improve the title text to use the human-friendly version of the component name ("Back link" rather than "back-link") and to remove a redundant "Link to read " from the start.
Add a full-stop to the end of the sentence.