18F / uswds-jekyll

A Jekyll theme showcasing the U.S. Web Design System

Home Page:https://federalist-proxy.app.cloud.gov/site/18f/uswds-jekyll/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

add private-eye

afeld opened this issue Β· comments

Background information

The logic for it currently exists in the Handbook, but really, the same πŸ”’-ing should apply to all TTS microsites. Let's move that logic for Private Eye into the theme.

Implementation steps

  • Add the logic to the theme
  • Confirm it works
  • Make the list of URLs configurable
  • Cut a new release
  • Upgrade the Handbook theme
  • Remove logic from the Handbook

Acceptance criteria

  • Links to private resources in any site that use this theme show up with a πŸ”’ icon

A usability & accessibility note: We have an open issue in the UX Guide to address the usability issue that people frequently don't recognize that the lock means they can not have access to the linked item. We get doc access requests a few times/week from people w/non-gov email addresses who have clicked on the Google 'Request access' button after following the link from the Guide. The Handbook version of Private Eye has a title attribute to explain that the "link is private to TTS," however the title attribute is problematic for accessibility.

When we have a recommendation for augmenting the icon, we'll add a comment here.

A question on scope: the plan is to add it to this repo, the uswds-jekyll theme, under the logic that as sites migrate to it, they'll pick it up, right? I want to confirm that's the scope, not adding it to all sites not currently using it.

Right; I was thinking we add it to the uswds-jekyll theme in a way where it's automatically enabled for all sites that use the theme. Making it further configurable by sites that use the theme is a nice-to-have.