Issue Template: Epic 4 Sub-Template — Apply Existing Solution (1 or More Pages)
What does this template do?
Creates a child fix-epic inside Epic 4 for errors and alerts that already have a documented solution in the Known Issues Index. The scope of work is to apply the existing solution to every affected page, one child issue per page.
When should this template be used?
Use this template inside Epic 4 when:
- A solution already exists in the Known Issues and Solutions Index.
The solution may apply to 1 page or many. If this is not the correct template, see the Wiki and Issue Templates page for all available templates.
Labels
Title
Epic: WAVE: [REPLACE WITH ONE OF: Alert / Contrast Error / Error]: [REPLACE WITH NAME OF Alert/Contrast Error/Error]
Body
<!-- Customize this epic issue by replacing all content in [ ] -->
### Overview
We need to apply the existing solution for
[REPLACE WITH ONE OF: Alert / Contrast Error / Error]:
[REPLACE WITH NAME OF Alert/Contrast Error/Error]
across all affected pages so the site can be WCAG compliant.
### Details
Category: [REPLACE WITH ONE OF: Alert / Contrast Error / Error]
Name: [REPLACE WITH NAME OF Alert/Contrast Error/Error]
(A solution already exists in the Known Issues Index — it just needs to be
applied to each affected page)
Known pages (there might be others):
1. [REPLACE WITH PAGE NAME 1]
1. [REPLACE WITH PAGE NAME N]
(add or remove rows as needed)
### Action Items
- [ ] Go to the Known Issues Solutions Index (resource 1.02) and confirm the
solution link for this issue; record it as resource 1.02.01
- [ ] Copy the child issue template (resource 1.04) and create one issue per
page listed above
- [ ] Add the following labels to each new child issue:
- `role: front-end`
- `size: missing`
- `p-feature: [REPLACE WITH PAGE NAME]`
- `feature: Accessibility`
- `level: missing`
- `ready for dev lead`
- `priority: MUST HAVE`
- [ ] Add milestone: [REPLACE WITH MILESTONE NAME, if applicable]
- Customize each child issue's resources:
- [ ] Update resource 1.02.01 and 1.02.02 with the application details
for the page
- [ ] Find the spreadsheet row for this page and error, and update
resource 1.03 with the correct link and row number(s)
- [ ] Add each new issue as a sub-issue of this epic
- [ ] Once all sub-issues are closed, run WAVE on all other pages for this
[REPLACE WITH ONE OF: Alert / Contrast Error / Error] only — ignore all
other errors and alerts. Check user interaction states as well.
- [ ] No additional instances found — close this epic
- [ ] Additional instances found — create new fix issues and add as
sub-issues
### Sub-Issues
<!-- Add one child issue per page once created -->
### Resources
- 1.01 WAVE Accessibility Audit Spreadsheet, tab: Audit Log:
[REPLACE WITH LINK TO AUDIT SPREADSHEET]
- 1.01.01 Audit Spreadsheet, filter:
[REPLACE WITH FILTER NAME FOR THIS ALERT/ERROR]
- 1.02 [WCAG Known Issues and Solutions](https://hackforla.github.io/accessibility/known-issues-and-solutions/)
- 1.02.01 https://hackforla.github.io/accessibility/known-issues-and-solutions/solutions-index/[REPLACE WITH SLUG-WITH-DASHES]/
- 1.03 Project documentation / page inventory:
[REPLACE WITH LINK TO YOUR PROJECT'S PAGE DOCS OR WIKI]
- 1.03.01 Documentation for [REPLACE WITH PAGE NAME] page:
[REPLACE WITH LINK OR LEAVE BLANK]
#### 1.04 Child Issue Template (one per page)
Title
Overview
We need to fix the [REPLACE WITH ONE OF: Alert / Contrast Error / Error]: [REPLACE WITH NAME OF Alert/Contrast Error/Error] on [REPLACE WITH PAGE NAME] so that the page is WCAG compliant.
Details
Category: [REPLACE WITH ONE OF: Alert / Contrast Error / Error] Name: [REPLACE WITH NAME OF Alert/Contrast Error/Error] (A solution already exists in the Known Issues Index — see resource 1.05.01)
Page to fix: [REPLACE WITH PAGE NAME]
Action Items
- Review how to run the WAVE browser extension (resource 1.01)
- Install the WAVE browser extension if not already installed
- Log in as the required user role (resource 1.02.01)
- Navigate to the page (resource 1.02.02)
- Open the audit spreadsheet and find the row for this page and error (resource 1.03)
- Run WAVE with no elements focused or clicked (resource 1.04)
- Locate the [REPLACE WITH ONE OF: Alert / Contrast Error / Error] in the WAVE output
- Review the
Project Team Solutionsection in the Known Issues Index (resource 1.05.01.01) and apply the solution - Submit a PR
- Add the PR link to the audit spreadsheet in the PR column for this row (resource 1.03)
- On this issue, add label:
ready for accessibility lead - Change status to:
Technical Review - On the parent epic, add label
ready for productand add the comment:
Resources
- 1.01 How to run the WAVE browser extension
- 1.02 Application details
- 1.02.01 User Profile Required: [REPLACE WITH USER TYPE: visitor / user / admin / etc.]
- 1.02.02 Page URL: [REPLACE WITH PAGE URL]
- Requires sign in: [REPLACE WITH TRUE OR FALSE]
- Can access page directly from URL: [REPLACE WITH TRUE OR FALSE]
- 1.03 WAVE Accessibility Audit Spreadsheet, tab: Audit Log, filter: [REPLACE WITH FILTER NAME]: [REPLACE WITH LINK TO SPREADSHEET]
- Spreadsheet Row(s): [REPLACE WITH ROW NUMBERS]
- 1.04 Perform a WAVE audit
- 1.05 WCAG Known Issues and Solutions Index
- 1.05.01 WAVE Known Accessibility Issue:
[REPLACE WITH ONE OF: Alert / Contrast Error / Error] —
[REPLACE WITH NAME OF Alert/Contrast Error/Error]:
[REPLACE WITH WIKI PAGE LINK]
- 1.05.01.01 Project Team Solution section: [REPLACE WITH DIRECT ANCHOR LINK TO SOLUTION SECTION]