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 clarification on parent agency in Identifier component #2591

Merged
merged 11 commits into from
Nov 7, 2024

Conversation

thisisdano
Copy link
Member

@thisisdano thisisdano commented Apr 2, 2024

Summary

Added clarification on parent agency in Identifier component. The identifier can be used by any site, regardless of whether that site has a higher-level agency associated with it. For this component, “Parent agency” means "the highest-level agency associated with a site or service." This PR adds guidance to cover cases when a site is the primary site for an agency, and has no higher-level agency.

Related issue

Closes #2592

Preview link

Preview link: Identifier page

Problem statement

Not every site has a parent agency. In some cases, a site or service is the primary site for an agency. (For example, dhs.gov is the primary site for the Department of Homeland Security. It does not have a "parent agency.") Our current guidance suggests that if a site doesn't have a parent agency, they shouldn't use the identifier. But this is not the case. Every site can use the identifier.

Our guidance should make it more clear that every site can use the identifier. When we talk about "parent agency," it's a simpler way of saying "the highest-level agency associated with a site or service."

Solution

This PR makes a couple additions to our identifier guidance.

  1. Add more inclusive language to the "When to use the identifier component" section:

To identify the highest-level agency associated with a site or service. The identifier is a complement to the USWDS banner. Use the identifier to tell users what parent agency is responsible for your website. Consider the parent agency to be the highest-level agency associated with a site or service. If your site is the primary site associated with an agency, you can still use the identifier.

  1. Add a clarification to the "Usability guidance" section:

Consider the parent agency the highest-level agency associated with a site or service. In some cases, your site may not have a parent agency. If your site is the primary site for your agency, use your agency name in place of [Parent Agency]. For example, “[agency.gov] An official website of [Agency].”

I do not suggest making a change to the component's dek: "The identifier communicates a site’s parent agency and displays agency links required by federal laws and policies." Most sites and services using the design system will have a parent agency, and the plain-language benefit to using "parent agency" in the dek may outweigh the clarity gained with the wordier phrasing.

Major changes

None

Testing and review

  1. Verify noted changes to the "When to use this component" section.
  2. Verify noted changes to the "Usability guidance" section.
  3. Check that the changelog accurately captures the nature of these clarifications.
  4. Check for spelling, grammar, plain language, and correctness.
  5. Check that there aren't any other places on this page that need a clarification.

Even sites that are the primary site for an agency can use the identifier. For this component, "parent agency" means "the highest-level agency associated with a site or service".
@thisisdano thisisdano marked this pull request as ready for review April 2, 2024 17:49
Copy link
Contributor

@sarah-sch sarah-sch left a comment

Choose a reason for hiding this comment

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

@thisisdano - laving some suggestions in the "Files changed" section. Also, please note that there is a typo on the Spanish-language component previews on this page. We should delete "An" from "An Un sitio web oficial de ." Let me know if you want me to create a separate ticket for the component preview changes.

_components/identifier/guidance/usability.md Outdated Show resolved Hide resolved
_components/identifier/guidance/when-to-use.md Outdated Show resolved Hide resolved
_data/changelogs/component-identifier.yml Outdated Show resolved Hide resolved
@sarah-sch
Copy link
Contributor

@thisisdano - added some suggestions to the files that were changed and noted that we should make some corrections to the Spanish-language component previews. Let me know if I should make a separate ticket for the component previews.

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Looks good to me! I added some comments below, but I consider them optional because I am not sure if any action needs to be taken.

Also, I looked into the issue with the Spanish-language component previews that @sarah-sch flagged and it looks like it is related to how USWDS builds out the html-templates. This issue will be addressed in uswds/uswds#5853.

_components/identifier/guidance/when-to-use.md Outdated Show resolved Hide resolved
@@ -1,4 +1,5 @@
- **Use the identifier component for required links.** If your site already includes the federally required links in its site footer, remove them in favor of the links in the identifier. This assures that site visitors find the required links in a consistent location from site to site.
- **Consider the parent agency to be the highest-level agency associated with a site or service.** In some cases, your site may not have a parent agency. If your site is the primary site for your agency, use your agency name in place of [Parent Agency]. For example, "[agency.gov] An official website of [Agency]."
- **Display the parent agency logo, not the product logo.** The identifier is meant to identify a website's parent agency as a complement to the site footer. Site-specific logos, like a product logo, should be in the site footer, not the identifier.
Copy link
Contributor

Choose a reason for hiding this comment

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

Optional

If I was in charge of implementing the identifier on a top-level agency site, I would wonder if I should use the logo in both the footer and the identifier (Especially considering the "Redundant content" note earlier on the page). Wondering if we should be explicit in our guidance about logos in that scenario here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd like to keep this update scoped to the general usage question, but this is a good point

Copy link
Contributor

@amyleadem amyleadem Apr 4, 2024

Choose a reason for hiding this comment

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

Optional

Flagging that we use "parent agency" for every item in this list except for the "Performance reports" item. Should we use "parent agency" in place of "agency" there as well?

Copy link
Member Author

@thisisdano thisisdano left a comment

Choose a reason for hiding this comment

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

Updating content

_components/identifier/guidance/usability.md Outdated Show resolved Hide resolved
_components/identifier/guidance/when-to-use.md Outdated Show resolved Hide resolved
_components/identifier/guidance/when-to-use.md Outdated Show resolved Hide resolved
_data/changelogs/component-identifier.yml Outdated Show resolved Hide resolved
@thisisdano thisisdano dismissed sarah-sch’s stale review November 6, 2024 23:08

Added editorial suggestions

@annepetersen annepetersen self-requested a review November 7, 2024 18:12
@annepetersen
Copy link
Contributor

Terminology used in M-23-22 that we may want to consider in the future:

  • Agency’s principal website
  • Agency’s principal sub-agency website

But for now, I do think this is more clear.

updating changelog date
@annepetersen annepetersen merged commit f9c1323 into main Nov 7, 2024
11 checks passed
@annepetersen annepetersen deleted the dw-identifier-parent branch November 7, 2024 18:49
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.

USWDS-Site - Bug: Identifier guidance doesn't cover cases when a site has no parent agency
4 participants