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.

Sign up for GitHub

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

Jump to bottom

Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1password (file names abbreviated) #2930

Closed
7 tasks done
JessicaLucindaCheng opened this issue Mar 5, 2022 · 2 comments · Fixed by #3176
Closed
7 tasks done

Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1password (file names abbreviated) #2930

JessicaLucindaCheng opened this issue Mar 5, 2022 · 2 comments · Fixed by #3176
Assignees
@juliansmith0
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue P-Feature: Toolkit https://www.hackforla.org/toolkit/ role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less Status: Updated No blockers and update is ready for review
Milestone
x. Technical debt

Comments

@JessicaLucindaCheng
Copy link
Member

JessicaLucindaCheng commented Mar 5, 2022 •
edited by juliansmith0
Loading

Overview

As a developer, I want to make sure unused code is removed from the codebase in the guide pages' HTML files, so that

  • time to load the website is as low as possible,
  • it's easier to understand the code, and
  • time to review the code is reduced.

For this issue, we will remove the unused alt-text fields from the guide pages' HTML files.

Details

At the top of each guide pages' HTML file, there is a section containing YAML front matter, which contains variables that can be accessed using Liquid tags. (See the links in the Resources/Instructions section for more information about front matter and Liquid tags.)

In the front matter of each guide pages' HTML file, there are the variables: svg and alt-text. svg field contains the location of a decorative image and alt-text is the alt text associated with the svg image. Currently, alt-text is not used anywhere in our codebase since the images are not used within an img HTML tag and the images are displayed through svg HTML tags.

Moreover, the alt text for all the images should be alt="" and will be programmatically set for all the alt properties associated with each image in issue #2929.

Action Items

Resources/Instructions
@JessicaLucindaCheng JessicaLucindaCheng added role: front end Tasks for front end developers P-Feature: Toolkit https://www.hackforla.org/toolkit/ Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 1pt Can be done in 4-6 hours labels Mar 5, 2022
@github-actions

This comment was marked as resolved.

Sign in to view
@ExperimentsInHonesty ExperimentsInHonesty changed the title Remove unused alt-text field in github-issues, responsible-use-of-images-on-opensource-projects, and setting-up-1-password-on-opensource-project HTML files Remove unused alt-text field in guide html files: issues, images, 1-password Mar 5, 2022
@ExperimentsInHonesty ExperimentsInHonesty changed the title Remove unused alt-text field in guide html files: issues, images, 1-password Remove unused alt-text field in toolkit guides html files: issues, images, 1-password (names abbreviated) Mar 5, 2022
@ExperimentsInHonesty ExperimentsInHonesty added this to the y. Technical debt milestone Mar 5, 2022
@JessicaLucindaCheng JessicaLucindaCheng changed the title Remove unused alt-text field in toolkit guides html files: issues, images, 1-password (names abbreviated) Remove unused alt-text field in toolkit guides html files: github-issues, images, 1-password (names abbreviated) Mar 6, 2022
@JessicaLucindaCheng JessicaLucindaCheng changed the title Remove unused alt-text field in toolkit guides html files: github-issues, images, 1-password (names abbreviated) Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1-password (names abbreviated) Mar 6, 2022
@JessicaLucindaCheng JessicaLucindaCheng changed the title Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1-password (names abbreviated) Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1password (names abbreviated) Mar 6, 2022
@JessicaLucindaCheng JessicaLucindaCheng changed the title Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1password (names abbreviated) Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1password (file names abbreviated) Mar 6, 2022
@JessicaLucindaCheng JessicaLucindaCheng added size: 0.5pt Can be done in 3 hours or less and removed size: 1pt Can be done in 4-6 hours Ready for Prioritization labels Mar 6, 2022
@KazushiR KazushiR assigned KazushiR and unassigned KazushiR Apr 3, 2022
@juliansmith0 juliansmith0 self-assigned this May 26, 2022
@juliansmith0
Copy link
Member

Availability for this week: 4.5 hours
My estimated ETA for completing this issue: Sunday, May 29, 2022

@juliansmith0 juliansmith0 mentioned this issue May 26, 2022
Merged
@github-actions github-actions bot added the Status: Updated No blockers and update is ready for review label May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@juliansmith0 juliansmith0

Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue P-Feature: Toolkit https://www.hackforla.org/toolkit/ role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less Status: Updated No blockers and update is ready for review
Projects
P: HfLA Website: Project Board
Archived in project
Milestone
x. Technical debt
4 participants
@juliansmith0 @JessicaLucindaCheng @ExperimentsInHonesty @KazushiR