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

Correct Semantic Markup for Section Headings and Tables #3179

Closed
1 of 2 tasks
SamiyahKey opened this issue Dec 3, 2024 · 5 comments
Closed
1 of 2 tasks

Correct Semantic Markup for Section Headings and Tables #3179

SamiyahKey opened this issue Dec 3, 2024 · 5 comments
Assignees
Labels
accessibility pertains to Section 508 compliance or other accessibility needs 👥 Pod:Accessibility Compliance Describes work needed for get.gov and manage.get.gov to be Section 508 Compliant compliance indicates that the issue is required to satisfy a necessary compliance req dev issue is for the dev team refinement

Comments

@SamiyahKey
Copy link

SamiyahKey commented Dec 3, 2024

Story

As a user relying on assistive technology,
I need section titles like "Audit Log" and "Registrar" to be properly marked up as headings,
So that I can easily understand and navigate the page's structure and hierarchy.

Site administration | Django site admin (cloud.gov)

Acceptance Criteria

  • Refactor the HTML to move "Audit Log" and "Registrar" as < h2 >.
  • Review other pages with similar issues to ensure consistent markup.

Additional Context

Image

Issue Links

No response

@SamiyahKey SamiyahKey added accessibility pertains to Section 508 compliance or other accessibility needs compliance indicates that the issue is required to satisfy a necessary compliance req dev issue is for the dev team skipped design Design artifact(s) will need to be updated labels Dec 3, 2024
@katypies katypies moved this from 👶 New to 🖌 Design Parking Lot in .gov Product Board Jan 14, 2025
@Katherine-MN
Copy link
Contributor

@SamiyahKey Can you add a screenshot of the "audit log" and "registrar" labels you're referring to? You can paste under Additional Context.

Also, for this AC: Include captions for tables as an optional enhancement to improve usability and context for all users.

  • That sounds like a separate ticket because I think dev would need content for those captions. Is that update required as part of the remediation plan? If not, let's extract that AC and turn it into a separate design ticket to tackle the content.

@SamiyahKey
Copy link
Author

@Katherine-Osos just updated the ticket with that screenshot. Also the captions are not 100% part of the remediation but is best practice for adding additional context to the page. I'll separate out into a separate ticket!

@zandercymatics zandercymatics added 👥 Pod:Accessibility Compliance Describes work needed for get.gov and manage.get.gov to be Section 508 Compliant and removed 👥 Pod:Accessibility Compliance Describes work needed for get.gov and manage.get.gov to be Section 508 Compliant labels Jan 29, 2025
@zandercymatics zandercymatics moved this from 🖌 Design Parking Lot to 🔖 Planned in .gov Product Board Feb 14, 2025
@zandercymatics zandercymatics self-assigned this Feb 14, 2025
@SamiyahKey SamiyahKey moved this from 🔖 Planned to 🎯 Ready in .gov Product Board Feb 18, 2025
@zandercymatics
Copy link
Contributor

zandercymatics commented Feb 18, 2025

@SamiyahKey Thinking from a screenreader perspective, should this be "caption" instead of an h2, since its a description for the table?

@SamiyahKey
Copy link
Author

@zandercymatics per our slack convo, yes lets do caption and I'll check it out when it's ready! ty

@zandercymatics zandercymatics moved this from 🎯 Ready to 👀 In review in .gov Product Board Feb 19, 2025
zandercymatics added a commit that referenced this issue Feb 20, 2025
…ames

#3180 / #3179: Aria-labels for "View", "Change", and "Add" buttons + correct semantic markup for section headings - [ZA]
@zandercymatics zandercymatics moved this from 👀 In review to ✅ Done in .gov Product Board Feb 20, 2025
@zandercymatics zandercymatics closed this as completed by moving to ✅ Done in .gov Product Board Feb 20, 2025
@witha-c
Copy link

witha-c commented Feb 28, 2025

Removed "skipped design" to reflect that an update to design documentation or libraries is not needed.

@witha-c witha-c removed the skipped design Design artifact(s) will need to be updated label Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility pertains to Section 508 compliance or other accessibility needs 👥 Pod:Accessibility Compliance Describes work needed for get.gov and manage.get.gov to be Section 508 Compliant compliance indicates that the issue is required to satisfy a necessary compliance req dev issue is for the dev team refinement
Projects
Status: ✅ Done
Development

No branches or pull requests

5 participants