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

Creating issues to update alt text for all projects in the _projects collection #3866

Closed
43 tasks done
MattPereira opened this issue Jan 24, 2023 · 8 comments
Closed
43 tasks done
Labels
Complexity: Large epic Feature: Accessibility Issues that would broaden website accessibility P-Feature: Projects page https://www.hackforla.org/projects/ role: back end/devOps Tasks for back-end developers role: dev leads Tasks for technical leads role: front end Tasks for front end developers size: 3pt Can be done in 13-18 hours Status: Updated No blockers and update is ready for review

Comments

@MattPereira
Copy link
Contributor

MattPereira commented Jan 24, 2023

Dependency

Overview

We need to ensure the alt text for project images adhere to Web Content Accessibility Guidelines (WCAG). For this epic, we will write issues to change the alt text for all project files in the _projects collection.

Details

Product Manager identified that the alt text for project images should be changed because they are either inaccurate or too long. According to the WCAG page, alt text should be descriptive but short and succinct.

Instructions

  • For each project, we will create an issue using the Title Template and Body Template from the Resources section of this issue.
  • [ PROJECT NAME ], [ PROJECT MD FILE ], and [ PROJECT SLUG ] will be replaced with the corresponding values for each project.
  • If you start with the Alt Text Audit - Dev issue template, most of the appropriate labels will be automatically added, but you will have to replace both the title and body of the issue completely with the templates provided below.

Action Items

  • This issue should only be assigned to a lead.
  • In the Dependency section of this issue, replace each project name with a link to the newly created issue that addresses changing the project's alt value
  • Once all the necessary issues have been created and added to this issue's dependency section, add a dependency label and move this issue to icebox column.
  • If all the dependency issues are closed, remove the dependency label, move this issue from ice box to In progress column and close this issue.

Resources

Title Template

[ PROJECT NAME ]: Update alt text for the [ PROJECT NAME ] image to adhere to WCAG

Body Template

### Prerequisite
1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our [Getting Started page](https://www.hackforla.org/getting-started).
2. Please make sure you have read our **[Hack for LA Contributing Guide](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)** before you claim/start working on an issue.
### Overview
As a developer, we need to provide clear and descriptive alt text for the [PROJECT NAME] image so that we adhere to the Web Content Accessibility Guidelines (WCAG) and we can achieve our mission of inclusivity.
### Action Items
- [ ] Change the alt value within `_projects/[ PROJECT MD FILE ]`:

**From:**
```
alt: [ REPLACE WITH CURRENT ALT VALUE ]
```
**To:**
```
alt: [ PROJECT NAME ]
```
**For PM, Merge Team, or Tech Lead**
- [ ] Once the pull request associated with this issue is approved and merged, please update and edit epic #3866 by
  - [ ] Checking off the dependency for this issue
  - [ ] If all dependencies are checked off, please move issue to the New Issue Approval column and remove the Dependency label

### Resources/Instructions
-  [ PROJECT NAME ] Page: https://www.hackforla.org/projects/[ PROJECT SLUG ] 

#### File and Code links you will need to work on this issue
- Directory to find the page in once you have it in your IDE:  `_projects/[ PROJECT MD FILE ]`
- See the source file code on the repo: https://github.com/hackforla/website/blob/gh-pages/_projects/[ PROJECT MD FILE ]
- This issue is part of epic #3866

#### Background information about the Jekyll framework (optional reading)
- [Jekyll Data Files](https://jekyllrb.com/docs/datafiles/)
- [Jekyll Front Matter](https://jekyllrb.com/docs/front-matter/)

#### Information about WCAG and alt text (optional reading)
- [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/)
- [Web Accessibility Tutorials: Decorative Images](https://www.w3.org/WAI/tutorials/images/decorative/)
- [WCAG section on alt text](https://www.w3.org/WAI/WCAG21/Techniques/html/H37.html)
- [Alt text decision Tree ](https://www.w3.org/WAI/tutorials/images/decision-tree/)
- [FAE rule 4: alt text should be less than 100 characters](https://fae.disability.illinois.edu/rulesets/IMAGE_4_EN/)
@MattPereira MattPereira added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Medium Collaborative Work Feature: Accessibility Issues that would broaden website accessibility P-Feature: Projects page https://www.hackforla.org/projects/ epic role: dev leads Tasks for technical leads size: 0.25pt Can be done in 0.5 to 1.5 hours labels Jan 24, 2023
@MattPereira MattPereira added this to the 08. Team workflow milestone Jan 24, 2023
@MattPereira MattPereira self-assigned this Jan 24, 2023
@github-actions

This comment was marked as off-topic.

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Jan 30, 2023

@MattPereira is there a template for the issues that you are making?

Example

In my example, I didn't make a template in the repo because it was only three issues: #3891

But given that the issues you will be making are many more, I would make a template, that way all the labels are automatically added each time you use it. But you can see from my template, I put in placeholders [TEXT IN CAPS] wherever I needed to replace something in the new issue.

@github-actions

This comment was marked as outdated.

@MattPereira
Copy link
Contributor Author

Progress: Most of the issues are created
Blockers: No blockers just a long tedious grind
Availability: 6 hours
ETA: End of Week

@chriskong217
Copy link

The project slug should be the actual name of the project, and should not include .md at the end. Putting .md at the end of the link will result in a 404 error.
In your template above, it has the following formatting:

Resources/Instructions

Work for LA Page: https://www.hackforla.org/projects/work-for-la.md

It should say:
Work for LA Page: https://www.hackforla.org/projects/work-for-la

@MattPereira MattPereira added the Dependency An issue is blocking the completion or starting of another issue label Feb 25, 2023
@chriskong217
Copy link

Resources/Instructions
https://www.hackforla.org/projects/311-data

The link should display the correct Home Unite Us link.

@ExperimentsInHonesty
Copy link
Member

@chrismenke45 chrismenke45 removed the Dependency An issue is blocking the completion or starting of another issue label May 31, 2023
@t-will-gillis
Copy link
Member

It appears that all 'dependency' issues tracked by this issue have been closed and as a result this issue was moved to "New Issue Approval" (?) and the Dependency label was removed.

Per the last "Action Item", this issue should be moved to "In progress" and then be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large epic Feature: Accessibility Issues that would broaden website accessibility P-Feature: Projects page https://www.hackforla.org/projects/ role: back end/devOps Tasks for back-end developers role: dev leads Tasks for technical leads role: front end Tasks for front end developers size: 3pt Can be done in 13-18 hours Status: Updated No blockers and update is ready for review
Projects
Development

No branches or pull requests

5 participants