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

A11Y: Move to Markdown (take 2) #9631

Merged
merged 39 commits into from
Oct 13, 2021
Merged

A11Y: Move to Markdown (take 2) #9631

merged 39 commits into from
Oct 13, 2021

Conversation

estelle
Copy link
Member

@estelle estelle commented Oct 6, 2021

✍️ Converted most of the a11y section to markdown.

  • ommitted the aria/aria_techniques section, since that needs a lot of editing.
  • omittied the aria/Roles as that is in a different PR
  • ommitted a few files that I will be deleting; so no need to create a md file for them. (deleting files will be a different PR)

❓ Why?
Because. That's why!
And, because it's what we do.

Metadata

  • Adds sever new documents, all .md, replacing the document of the same name with .html
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

@estelle estelle requested a review from a team as a code owner October 6, 2021 19:09
@estelle estelle requested review from ericwbailey and removed request for a team October 6, 2021 19:09
@estelle estelle marked this pull request as draft October 6, 2021 19:09
@github-actions github-actions bot added the Content:Accessibility Accessibility docs label Oct 6, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 6, 2021

Preview URLs

Flaws

Note! 23 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/Accessibility
Title: Accessibility
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Accessibility

URL: /en-US/docs/Web/Accessibility/ARIA/ARIA_Screen_Reader_Implementors_Guide
Title: ARIA Screen Reader Implementors Guide
on GitHub
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/Accessibility/ARIA/Roles/Log_role
    • Can't resolve /en-US/docs/AJAX/WAI_ARIA_Live_Regions/API_Support

URL: /en-US/docs/Web/Accessibility/ARIA/Annotations
Title: ARIA annotations
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-us/docs/web/accessibility/aria/roles/mark_role

URL: /en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions
Title: ARIA live regions
on GitHub
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/Docs/Web/Accessibility/ARIA/Roles/Alert_role
    • Can't resolve /en-US/Docs/Web/Accessibility/ARIA/Roles

URL: /en-US/docs/Web/Accessibility/Cognitive_accessibility
Title: Cognitive accessibility
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/Accessibility/Seizure_disorders
Title: Web accessibility for seizures and physical reactions
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/API/CSSKeyframe/keyText

External URLs

URL: /en-US/docs/Web/Accessibility
Title: Accessibility
on GitHub


URL: /en-US/docs/Web/Accessibility/Mobile_accessibility_checklist
Title: Mobile accessibility checklist
on GitHub


URL: /en-US/docs/Web/Accessibility/Index
Title: Accessibility documentation index
on GitHub

No new external URLs


URL: /en-US/docs/Web/Accessibility/Information_for_Web_authors
Title: Accessibility Information for Web Authors
on GitHub


URL: /en-US/docs/Web/Accessibility/Accessibility:_What_users_can_to_to_browse_safely
Title: Accessibility: What users can do to browse more safely
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_Colors_and_Luminance
Title: Web Accessibility: Understanding Colors and Luminance
on GitHub


URL: /en-US/docs/Web/Accessibility/FAQ
Title: Accessibility FAQ
on GitHub


URL: /en-US/docs/Web/Accessibility/ARIA
Title: ARIA
on GitHub


URL: /en-US/docs/Web/Accessibility/ARIA/forms
Title: Forms
on GitHub


URL: /en-US/docs/Web/Accessibility/ARIA/ARIA_Screen_Reader_Implementors_Guide
Title: ARIA Screen Reader Implementors Guide
on GitHub

No new external URLs


URL: /en-US/docs/Web/Accessibility/ARIA/How_to_file_ARIA-related_bugs
Title: How to file ARIA-related bugs
on GitHub


URL: /en-US/docs/Web/Accessibility/ARIA/ARIA_Guides
Title: ARIA guides
on GitHub

No new external URLs


URL: /en-US/docs/Web/Accessibility/ARIA/Annotations
Title: ARIA annotations
on GitHub


URL: /en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions
Title: ARIA live regions
on GitHub


URL: /en-US/docs/Web/Accessibility/Keyboard-navigable_JavaScript_widgets
Title: Keyboard-navigable JavaScript widgets
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG
Title: Understanding the Web Content Accessibility Guidelines
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG/Robust
Title: Robust
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG/Perceivable
Title: Perceivable
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG/Text_labels_and_names
Title: Text labels and names
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG/Operable
Title: Operable
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG/Understandable
Title: Understandable
on GitHub


URL: /en-US/docs/Web/Accessibility/Understanding_WCAG/Keyboard
Title: Keyboard
on GitHub


URL: /en-US/docs/Web/Accessibility/Cognitive_accessibility
Title: Cognitive accessibility
on GitHub


URL: /en-US/docs/Web/Accessibility/Community
Title: Community
on GitHub


URL: /en-US/docs/Web/Accessibility/Accessible_dynamic_content
Title: Accessible dynamic content
on GitHub

No new external URLs


URL: /en-US/docs/Web/Accessibility/Seizure_disorders
Title: Web accessibility for seizures and physical reactions
on GitHub


URL: /en-US/docs/Web/Accessibility/An_overview_of_accessible_web_applications_and_widgets
Title: An overview of accessible web applications and widgets
on GitHub


URL: /en-US/docs/Web/Accessibility/Architecture
Title: Architecture
on GitHub


URL: /en-US/docs/Web/Accessibility/Accessibility_and_Spacial_Patterns
Title: Accessibility and Spacial Patterns
on GitHub

(this comment was updated 2021-10-12 21:39:30.117950)

@estelle estelle requested a review from wbamberg October 6, 2021 20:42
@estelle estelle added the markdown Issues related to Markdown conversion label Oct 6, 2021
@estelle estelle marked this pull request as ready for review October 6, 2021 20:43
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

Mostly some unconverted elements and some tables which should stay in HTML even though they were converted.

These pages:
https://pr9631.content.dev.mdn.mozit.cloud/en-US/docs/Web/Accessibility/Accessibility_and_Spacial_Patterns
https://pr9631.content.dev.mdn.mozit.cloud/en-US/docs/Web/Accessibility/ARIA/ARIA_Test_Cases
https://pr9631.content.dev.mdn.mozit.cloud/en-US/docs/Web/Accessibility/ARIA/Web_applications_and_ARIA_FAQ
https://pr9631.content.dev.mdn.mozit.cloud/en-US/docs/Web/Accessibility/ARIA/widgets
https://pr9631.content.dev.mdn.mozit.cloud/en-US/docs/Web/Accessibility/Information_for_Web_authors

...were renamed but not converted - if I understand you right then it was intentional to not convert them, but I think in this case we should not rename them either, so we know we haven't converted them.

@estelle
Copy link
Member Author

estelle commented Oct 12, 2021

Getting the warning "This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository." so changes aren't showing up. Otherwise, work is complete.

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

Thanks @estelle ! There are still a few unconverted bits of HTML, but let's merge this, we can always fix them later.

@wbamberg wbamberg merged commit 879c027 into mdn:main Oct 13, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:Accessibility Accessibility docs markdown Issues related to Markdown conversion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants