Open JessicaLucindaCheng opened 1 year ago
Awaiting approval before writing more issues: https://github.com/hackforla/website/issues/4366#issuecomment-1493273041
We want to change img HTML tags ending with a slash (
See the write-up for DR: img tag
documentation comment {See 1 in Resources/Instructions below}
DR: img tag
documentation commentI audited some of the pages and wrote some of the issues.
Complexity: Small
issue to audit each pageimg with Ending Slash
tab depends on
Link to page on website (if applicable)
column is filled out), follow the Instructions for issue writers where "Link to page on website (if applicable)" column is filled out
on the Instructions tabLink to page on website (if applicable)
column is not filled out), determine how to write the issues for those. CONTRIBUTING.md
and .github/pull_request_template.md
are not files for the website and will not have Link to page on website (if applicable)
column filled out. Thus, if they have img tags with an ending slash <img.../>
, then you'll need to figure out how to write the issues for those. <img.../>
to <img...>
. @hackforla/website-pm
To Dos
@JessicaLucindaCheng I took off the ready for product label because I think you got the feedback you needed from me last Monday
Hello @JessicaLucindaCheng , I would like to work on the issue mentioned above.
@jiyanpatil07 In order to work on an issue, you need to be a member of Hack for LA. (There are no fees to join.) Please follow the steps on our Getting Started page and attend an onboarding session.
[^1]: HfLA-Website: img Tag Audit spreadsheet
[^2]: HfLA-Website: img Tag Audit spreadsheet's Page Audit tab
[^3]: HfLA-Website: img Tag Audit spreadsheet's img with Ending Slash tab
[^4]: Issue Template 1: img Tag Refactor on Website and its associated Markdown file .github/ISSUE_TEMPLATE/img-tag-refactor-on-website.md. This template works for any pages that is marked with Template 1
in the Template to use if <img.../> found
column on the Page Audit
tab . Template 1 works if the img tag is on the website.
@hackforla/website-merge Can someone read through and review this issue and its roll out plan to see if it is ready for prioritization? If you are interested, please leave your issue review availability and ETA in a new comment below. Thank you.
@JessicaLucindaCheng Availability: 5/26 1 hr, 5/27 1 hr, 5/28 1 hr ETA 5/28 EOD
Is there any documentation I could reference to understand the meaning of the various "Issue Making" labels?
@roslynwythe Thanks for reviewing this roll out plan!
Is there any documentation I could reference to understand the meaning of the various "Issue Making" labels?
Hi @JessicaLucindaCheng This looks good and it was interesting to see how you structured this Roll Out Plan into two child Epics. Your instructions are quite clear and I would feel comfortable working on this epic (or the child epics).
@roslynwythe Thanks for reviewing the roll out plan!
Questions for PM(s) and the answers:
Since Issue Making and Complexity issues are done in intertwined, parallel growth paths:
Since this issue is for any front-end or back-end dev, will putting an existing Complexity label (good first, small, medium, or large) on this be confusing?
Ans: Yes, it is confusing using those labels.
If we are adding a complexity label, I suggest we make a new label Complexity: Issue Making
to indicate to look at the Issue Making labels. Is that okay?
Ans: Bonnie said yes, but word it Complexity: See issue making label
@JessicaLucindaCheng that seems like a reasonable suggestion
Hi @roslynwythe, thank you for taking up this issue! Hfla appreciates you :)
Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)
You're awesome!
P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, July 25, 2023 at 12:15 AM PST.
Update:
This Roll Out plan is in progress, and will remain open until all of the issues created as a result of #4922 and #5040 are closed.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, August 8, 2023 at 12:06 AM PST.
@roslynwythe Someone was asking about one of the issues that came out of this issue and I was thinking this could be done with a processing script.
Anyway, it seems like an opportunity for me to work on my commandline tools skills so I came up with this one-liner that runs from the project root.
It’s not entirely correct but I guess I don’t want to spend more time on it right now. It does what it’s supposed to but also has the side effect of removing extra spaces in all tags.
find . -name "*.html" -exec sed -i -e "s/<img\(.*\)\/>/<img\1>/g" -e "s/\s*>/>/g" {} +
sed
to process themsed
edit files in-place (-i flag) with 2 edit commands. {} is a placeholder for the file path and + is the endingimg
tagsHere is the one to process just one file that I originally worked on.
sed -i -e "s/<img\(.*\)\/>/<img\1>/g" -e "s/\s*>/>/g" ./_includes/about-page/about-card-executive-letter.html
Another major problem is it doesn't match img tags spread across multiple lines. So it didn't catch this file, which I used the "/>" regex to find all self-closing tags and manually went through the results.
Anyway, the commands might be good for checking purposes or if you ever need to remove extra spaces in all tags. I just want to leave this here since it's related to this issue.
Hi @fyliu that sed command is really impressive!! As you may know, we are always looking for good first issues
for our junior developers on the website project. So I'd like to generate a list of files with html tags with extra spaces that I could use for creating good first issues. If you have a suggestion for that, please let me know. If you would like, I'll create an issue..
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, August 22, 2023 at 12:06 AM PST.
@roslynwythe Here's some commands to find extra spaces within tag brackets.
Run these from the project root:
This one finds tags that have extra ending spaces
find . -name "*.html" -exec grep -lrP "<[^>]+\s+>" {} + | sort -u
find . -name "*.html" -exec grep -nrP --color=always "<[^>]+\s+>" {} + | sort -u | less -r
<
and the >
, with the middle having characters that are not the closing bracket ([^>]) and having at least one space character (\s).| less -r
displays the results in a scrollable buffer. You can do page-scroll f
orward and b
ack as well as use arrow keys for single lines. q
to quit> extra-spaces.txt
at the end of the command. The color might show up as code so it's best to not have colors when saving to file.Here's another one that finds multiple consecutive spaces inside tags
find . -name "*.html" -exec grep -lrP "<[^>]+\s{2,}[^>]+>" {} + | grep -v -e "-->" | sort -u
find . -name "*.html" -exec grep -nrP --color=always "<[^>]+\s{2,}[^>]+>" {} + | grep -v -e "-->" | less -r
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, August 29, 2023 at 12:06 AM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, September 5, 2023 at 12:05 AM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, September 12, 2023 at 12:06 AM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, September 19, 2023 at 12:06 AM PST.
Now that we have a template for updates to CONTRIBUTING.md, I'm planning to create the img tag refactoring issues targeting CONTRIBUTING.md
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, October 31, 2023 at 12:06 AM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, November 6, 2023 at 11:05 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, November 13, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, November 20, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, November 27, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, December 4, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, December 11, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, December 18, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, December 25, 2023 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, January 1, 2024 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, January 8, 2024 at 11:05 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, January 15, 2024 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, January 22, 2024 at 11:05 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, January 29, 2024 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, February 5, 2024 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, February 12, 2024 at 11:05 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, February 19, 2024 at 11:06 PM PST.
@roslynwythe
Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.
If you need help, be sure to either: 1) place your issue in the Questions/In Review
column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Monday, February 26, 2024 at 11:06 PM PST.
Dependency
Overview
We want to change img HTML tags ending with a slash ( ) to an img tag without an ending slash () so that the codebase is consistent with how we use img HTML tags.
Details
DR: img tag
documentation comment [^1]Action Items
Resources/Instructions
[^1]:
DR: img tag
documentation comment[^2]: Roll out plan
[^3]: HfLA-Website: img Tag Audit spreadsheet
[^4]: To understand the Issue Making labels, refer to the Resources section of this ER: #4678
[^5]: Issue Template 1: img Tag Refactor on Website and its associated Markdown file .github/ISSUE_TEMPLATE/img-tag-refactor-on-website.md. This template works for any pages that are marked with
Template 1
in theTemplate to use if <img.../> found
column on thePage Audit
tab. Template 1 works if the img tag is on the website.