Remove unused alt-text field in toolkit guides html files: github-issues, use-of-images, 1password (file names abbreviated) #2930
Description
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
- Remove the line of code with the
alt-textfield in the following files only:- github-issues.html
website/_guide-pages/github-issues.html
Line 19 in da95793
- responsible-use-of-images-on-opensource-projects.html
- setting-up-1password-on-opensource-project.html
- github-issues.html
- The guide pages' HTML files are used on the website in the Toolkit page and the guides linking from the Toolkit page.
- Check the Toolkit page and make sure it looks the same as the current Toolkit page
- Check each guide page by clicking on its link in the Toolkit and making sure it looks the same as guides on the current website
Resources/Instructions
- Information about Front Matter as used by Jekyll
- Introduction to Liquid, including information on tags
- Toolkit page
- Directory to find the files once you have it in your IDE: _guide-pages
- Click on the links below to see the code for each file:
website/_guide-pages/github-issues.html
Line 19 in da95793