patternfly / patternfly/patternfly-org
Create accessibility documentation for our components
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
Describe the issue. What is the expected and unexpected behavior?
We should add an accessibility tab to each component's documentation explaining the general accessibility considerations and requirements so that users have a greater understanding of how to use PF components accessibly.
Is this a bug or enhancement? If this issue is a bug, is this issue blocking you or is there a work-around?
Enhancement
Related issue(s):
- #2960
Components to be documented (moving forward, follow the writing a11y documentation wiki page):
-
#2550
-
#2551
-
#2552
-
#2566
-
#2568
-
#2574
-
#2573
-
#2687
-
#2690
-
#2768
-
#2751
-
#2777
-
#2564
-
#2557
-
#2714
-
#2576
-
#2578
-
#2779
-
#2579
-
#2580
-
#2801
-
#2581
-
Data list
-
Date picker
-
Description list
-
Divider
-
Drawer
-
#2582
-
Dual List Selector
-
Empty state
-
#2824
-
File upload
-
Form
-
Form control
-
Form select
-
#2917
-
Hint
-
#3810
-
Inline edit
-
Input group
-
#2825
-
#2584
-
Label group (will be covered by #3460 )
-
List
-
Login page
-
Masthead
-
#3255
-
#3264
-
#2585
-
#3253
-
Notification badge
-
Notification Drawer
-
Number input
-
Options menu
-
Overflow menu
-
#2601
-
Pagination
-
#2590
-
#3244
-
#4187
-
Search input
-
#2591
-
#2683
-
Simple List
-
#2592
-
#2600
-
Spinner
-
#4120
-
Tab Content
-
#2594
-
#2593
-
Text
-
Text area
-
Text input
-
Tile
-
#2598
-
Time picker
-
Toggle group
-
#2595
-
#2596
-
#2599
-
#2597
Components that need updating to follow the new a11y doc writing guidelines:
-
#3034
-
#3071
-
#3795
-
#3241
-
#3257
-
#3242
-
#3248
-
#3251
-
#3276
-
#3258
-
#3278
-
#3280
-
#3286
-
#3288
-
#3112
-
#3292
-
#3294
-
#3378
-
#3797
-
Context Selector (deprecated, no update required)
-
#3800
-
#3804
-
#3807
-
Label (will be covered by #3460 )
-
#3346
-
#3874
-
#3811
-
#3809
-
#3825
-
#3826
-
#3875
Jira Issue: PF-581
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked “Writing accessibility documentation for PatternFly” wiki page, then review the unchecked components in this issue and their existing documentation. Add an accessibility tab for each selected component covering the required accessibility considerations, and mark the component complete when its documentation follows the stated guidelines.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100