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

Update accessibility.mdx #4184

Merged
merged 11 commits into from
Aug 29, 2024
Merged

Update accessibility.mdx #4184

merged 11 commits into from
Aug 29, 2024

Conversation

mbgower
Copy link
Contributor

@mbgower mbgower commented Jul 30, 2024

Tried moving the accessibility status to the bottom of the page, as per #3960

Since the H3 is generated in code, I'm just leaving it as is. This becomes a subsection of Development considerations, which works fine.
https://carbondesignsystem-git-mbgower-patch-1-carbon-design-system.vercel.app/components/accordion/accessibility

Closes #3960

Tried moving the accessibility status to the bottom of the page, as per #3960 

Since the H3 is generated in code, I'm just leaving it as is. Expectation is that this will be a subsection of Development considerations, which works fine.
Not showing up in preview.
@mbgower mbgower requested review from a team as code owners July 30, 2024 13:32
Copy link

vercel bot commented Jul 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
carbondesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 29, 2024 5:31pm

@alisonjoseph
Copy link
Member

If we're moving this section to the bottom (and updating to a h2) we probably should add an anchor link for "Accessibility testing status" to the top of these pages also.

@mbgower
Copy link
Contributor Author

mbgower commented Jul 30, 2024

If we're moving this section to the bottom (and updating to a h2) we probably should add an anchor link for "Accessibility testing status" to the top of these pages also.

Note that I am not altering the content here at all (not making it an H2). I'm just repositioning <A11yStatus layout="table" components="Accordion" />

I agree the H2 and TOC could take place, but that requires additional changes that I cannot do on my lonesome. This first step could be done across the board by me easily, and it would set up all the pages to later be updated to H2 (which I think is just one global change). I think the TOC would need to be done manually per page, although could be done as one GSR, in all likelihood.

And finally, note that this repositioning is clean. The page works that way -- in fact the existing H3 for the accessibility testing makes hierarchical sense where I reposition it, while it makes no sense in its current location

Copy link
Member

@thyhmdo thyhmdo 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.

Copy link
Contributor

@Kritvi-bhatia17 Kritvi-bhatia17 left a comment

Choose a reason for hiding this comment

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

Hi @mbgower! This looks good 🎉
Just a quick confirmation—will the change in this PR need to be updated in all the other components as well?

@laurenmrice
Copy link
Member

@Kritvi-bhatia17 @mbgower Yes, I believe he said he would make the change in this PR for all of them, once we agreed on a direction. So we should wait to merge.

mbgower and others added 3 commits August 26, 2024 13:38
Changed 28 components that were previously revised to the standard accessibility tab layout
Move the accessibility testing to the bottom of pages that have not been updated to the current accessibility tab template
A number of pages had the A11yStatus formed with indented code, so my GSR failed to locate.
As well, a manual check of each page (which I did by navigating to the Accessibility tab and clicking the Development considerations on-page link), showed that a few of the on-page links were malformed.
Missed popover testing section
@mbgower
Copy link
Contributor Author

mbgower commented Aug 26, 2024

@laurenmrice I've now repositioned on all relevant pages, and cleaned up a couple of in-page links at the same time.
The only other thing we may want to consider doing with this PR is that there are several pages that were never updated to the new accessibility tab template (because the component was scheduled to be updated/replaced). These have an Accessibility testing H2. Repositioning still works on these pages, since the new material complements the legacy testing info on these pages; however, if you want I could strip out the legacy test stuff. Those pages are:

@laurenmrice
Copy link
Member

@mbgower This looks great. Thank you! If you don't mind doing it in this PR, it would be good to strip those components of the legacy content for now. I also noticed that List does not have a page header.

These five components had not had their Accessibility tab info updated due to various reasons. We elected to strip out the old testing results.
I left the H2 for Testing in place.
@mbgower
Copy link
Contributor Author

mbgower commented Aug 29, 2024

@laurenmrice I've removed the legacy testing material from those five. I left the "Accessibility testing" H2 in place, but stripped out its paragraph of text (since it wasn't always accurate, based on the results) and just followed up immediately with the H3 of the "Accessibility testing status". It's not beautiful, but seemed like the least inelegant of the solutions for these five ugly duckling topics. :)

I also noticed that List does not have a page header.

I don't understand this. The updated page looks fine to me?

Copy link
Member

@laurenmrice laurenmrice 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! Thank you!

@mbgower mbgower merged commit fababc6 into main Aug 29, 2024
7 checks passed
@mbgower mbgower deleted the mbgower-patch-1 branch August 29, 2024 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The Accessibility testing status section of the Accessibility tab should follow the Development considerations
5 participants