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

[WNMGDS-2697] Update label guidance #3008

Merged
merged 7 commits into from
Apr 17, 2024
Merged

Conversation

pwolfert
Copy link
Contributor

@pwolfert pwolfert commented Apr 1, 2024

Summary

WNMGDS-2697

Label guidance was outdated, so we requested they be rewritten by the content team. Here are the updates.

How to test

Take a look at the affected pages on the doc site.

Checklist

  • Prefixed the PR title with the Jira ticket number as [WNMGDS-####] Title or [NO-TICKET] if this is unticketed work.
  • Selected appropriate Type (only one) label for this PR, if it is a breaking change, label should only be Type: Breaking
  • Selected appropriate Impacts, multiple can be selected.
  • Selected appropriate release milestone

If this is a change to documentation:

  • Checked for spelling and grammatical errors

pwolfert added 3 commits April 1, 2024 16:10
… putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code styles
@pwolfert pwolfert added Impacts: Documentation Indicates that this item relates to documentation Type: Changed Indicates a change to an existing element of the DS. labels Apr 1, 2024
@pwolfert pwolfert added this to the 10.0.0-beta.3 milestone Apr 1, 2024
@pwolfert pwolfert requested a review from zarahzachz April 1, 2024 23:27
@@ -4,7 +4,7 @@ title: Forms

The design system includes components for the standard HTML form elements: [checkboxes](/components/checkbox/) and [radio buttons](/components/radio/), [text fields](/components/text-field/), [dropdowns ](/components/dropdown/), fieldsets, labels, and so on.

Below are some best practices your project should aim to follow in order to provide the most accessible and usable experience for your users. Additional guidance, specific to each form field, is provided in each component's guidance tab.
Below are some best practices your project should follow in order to provide the most accessible and usable experience for your users. Additional guidance, specific to each form field, is provided in each component's guidance tab.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just curious - what's a "guidance tab"? Is this referring to the guidance sections we have?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Huh, I wonder if that was borrowed. I didn't notice that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, it was there originally. Must have been a time when the doc site was structured differently

@pwolfert pwolfert modified the milestones: 10.0.0-beta.3, 11.0.0-beta.1 Apr 4, 2024
@pwolfert pwolfert merged commit f51ca6a into main Apr 17, 2024
1 check passed
@pwolfert pwolfert deleted the pwolfert/update-label-guidance branch April 17, 2024 21:01
@pwolfert pwolfert modified the milestones: 11.0.0-beta.1, 10.1.0 May 3, 2024
pwolfert added a commit that referenced this pull request May 10, 2024
* Update label guidance according to content team directions

* Get rid of extra little space

* Looks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code stylesLooks better without putting these in code styles

* There are no guidance "tabs"

* Update guidance after talking through Sarah's feedback with content team
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impacts: Documentation Indicates that this item relates to documentation Type: Changed Indicates a change to an existing element of the DS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants