Epic: Create template, spreadsheet and list of issues for spellcheck audit

[roslynwythe]

Dependency

• Run VS Code Spell Checker on pages/about.html #5739
• Run VS Code Spell Checker on pages/404.html #5738
• Run VS Code Spell Checker on .github/pull_request_template.md #5736
• Run VS Code Spell Checker on CONTRIBUTING.md #5737
• Run VS Code Spell Checker on _layouts/project.html #5735
• Run VSCode Code Spell Checker on _guide-pages/2FA.html #5311
• Run VSCode Code Spell Checker on _guide-pages/survey-reporting-dashboard-guide.html #5514
• Run VSCode Code Spell Checker on _includes/about-page/about-card-news.html #5515
• Run VSCode Code Spell Checker on _guide-pages/github-issues.html #5516
• Run VSCode Code Spell Checker on _includes/about-page/about-card-donations.html #5518
• Run VSCode Code Spell Checker on _includes/about-page/about-card-executive-letter.html #5519
• Run VS Code Spell Checker on _includes/guide-card.html #5595
• Run VS Code Spell Checker on _includes/press.html #5596
• Run VS Code Spell Checker on _includes/wins-pages/wins-card-template.html #5600
• Run VS Code Spell Checker on _includes/resource-card.html #5598
• Run VSCode Spell Checker on _includes/about-page/about-card-partners.html #5524
• Run VSCode Spell Checker on _includes/about-page/about-card-platform.html #5525
• Run VSCode Spell Checker on _includes/about-page/about-card-sponsors.html #5526
• Run VSCode Spell Checker on _includes/about-page/about-card-sustainability.html #5527
• Run VSCode Spell Checker on _includes/design-system-page/examples/page-cards/image-page-card-photo.html #5528
• Run VSCode Spell Checker on _includes/design-system-page/examples/page-cards/image-page-card-icon.html #5529
• Run VSCode Code Spell Checker on _includes/about-page/about-card-metrics.html #5520
• Run VSCode Spell Checker on _includes/donation/donate-gif-text.html #5530
• Run VSCode Spell Checker on _includes/donate-card.html #5531
• Run VSCode Spell Checker on _includes/events-page/left-col-content.html #5532
• Run VSCode Spell Checker on _includes/events-page/our-locations-content.html #5533
• Run VSCode Code Spell Checker on _includes/about-page/about-card-accomplishments.html #5517
• Run VSCode Spell Checker on _includes/about-page/about-card-sustainability.html #5527
• Run VS Code Spell Checker on _layouts/guides.html #5604
• Run VS Code Spell Checker on _includes/events-page/right-col-content.html #5594
• Run VS Code Spell Checker on _layouts/guide-pages.html #5603
• Run VS Code Spell Checker on _includes/wins-pages/wins-overlay.html #5602
• Run VS Code Spell Checker on _includes/sponsors.html #5599
• Run VS Code Spell Checker on _includes/program-area-pages-cards.html #5597
• Run VS Code Spell Checker on pages/citizen-engagement.html #5981
• Run VS Code Spell Checker on pages/code-of-conduct.html #5982
• Run VS Code Spell Checker on pages/communities-of-practice.html #5983
• Run VS Code Spell Checker on pages/credits.html #5984
• Run VS Code Spell Checker on pages/dashboard.html #5985
• Run VS Code Spell Checker on pages/design-system.html #5986
• Run VS Code Spell Checker on pages/donate.html #5987
• Run VS Code Spell Checker on pages/events.html #5988
• Run VS Code Spell Checker on pages/getting-started.html #5989
• Run VS Code Spell Checker on pages/index.html #5990
• Run VS Code Spell Checker on pages/join-us.html #5991
• Run VS Code Spell Checker on pages/privacy-policy.html #5992
• Run VS Code Spell Checker on pages/program-areas.html #5993
• Run VS Code Spell Checker on pages/project-meetings.html #5994
• Run VS Code Spell Checker on pages/projects-check.html #5995
• Run VS Code Spell Checker on pages/projects-page.html #5996
• Run VS Code Spell Checker on pages/sitemap.html #5997
• Run VS Code Spell Checker on pages/toolkit.html #5998
• Run VS Code Spell Checker on _data/internal/accomplishments.yml #6086
• Run VS Code Spell Checker on _data/internal/events.yml #6087
• Run VS Code Spell Checker on _data/internal/partners.yml #6088
• Run VS Code Spell Checker on _data/internal/privacy-policy.yml #6089
• Run VS Code Spell Checker on _data/internal/sponsors.yml #6090
• Run VS Code Spell Checker on _data/internal/testimonials.yml #6091
• Run VS Code Spell Checker on _data/internal/toolkitresources.yml #6092
• Run VS Code Spell Checker on _data/internal/communities/data-science.yml #6093
• Run VS Code Spell Checker on _data/internal/communities/engineering.yml #6094
• Run VS Code Spell Checker on _data/internal/communities/ops.yml #6095
• Run VS Code Spell Checker on _data/internal/communities/project-management.yml #6096
• Run VS Code Spell Checker on _data/internal/communities/ui-ux.yml #6097
• Run VS Code Spell Checker on .github/ISSUE_TEMPLATE/img-tag-refactor.md #6487
• Run VS Code Spell Checker on pages/guides.html  #6488
• Run VS Code Spell Checker on assets/js/wins.js #6489
• Run VS Code Spell Checker on _data/external/_wins-data.json #6490
• Run VS Code Spell Checker on _data/external/github-data.json #6491
• Run VS Code Spell Checker on _data/external/vrms_data.json #6492
• Run VS Code Spell Checker on _data/internal/press/cnn.yml #6493
• Run VS Code Spell Checker on _data/internal/press/gov_tech.yml #6494
• Run VS Code Spell Checker on _data/internal/press/la_times.yml #6495
• Run VS Code Spell Checker on _program-areas/citizen-engagement-card.yml #6496
• Run VS Code Spell Checker on _program-areas/civic-tech-infrastructure-card.yml #6497
• Run VS Code Spell Checker on _program-areas/diversity-equity-inclusion-card.yml #6498
• Run VS Code Spell Checker on environment-card.yml #6569
• Run VS Code Spell Checker on justice-card.yml #6570
• Run VS Code Spell Checker on social-safety-net-card.yml #6571
• Run VS Code Spell Checker on vote-representation-card.yml #6572
• Run VS Code Spell Checker on workforce-development-card.yml #6573
• Run VS Code Spell Checker on sdg11.yml #6574
• Run VS Code Spell Checker on sdg2.yml #6575
• Run VS Code Spell Checker on sdg3.yml #6576
• Run VS Code Spell Checker on design-system.yml #6577
• Run VS Code Spell Checker on main.yml #6578
• Run VS Code Spell Checker on social.yml #6585
• Run VS Code Spell Checker on button.md  #6590
• Run VS Code Spell Checker on page-card.md  #6591
• Run VS Code Spell Checker on standard-header-page.md #6592
• Run VS Code Spell Checker on about.md #6593
• Run VS Code Spell Checker on colors.md #6594
• Run VS Code Spell Checker on updates-team-pages-on-hflasite.html #6758
• Run VS Code Spell Checker on survey-reporting-dashboard-guide.html #6757
• Run VS Code Spell Checker on _guide-pages/using-kanban-project.html #7142
• Run VS Code Spell Checker on _includes/about.html #7143
• Run VS Code Spell Checker on _includes/calendar.html #7144
• Run VS Code Spell Checker on _includes/current-guides.html #7145
• Run VS Code Spell Checker on _includes/current-projects-check.html #7146
• Run VS Code Spell Checker on _includes/current-projects.html #7147
• Run VS Code Spell Checker on _includes/donate-button.html #7148
• Run VS Code Spell Checker on _includes/footer.html #7149
• Run VS Code Spell Checker on ems-triage-tracker.md #7448
• Run VS Code Spell Checker on engage.md #7449
• Run VS Code Spell Checker on expunge-assist.md #7450
• Run VS Code Spell Checker on food-oasis.md #7451
• Run VS Code Spell Checker on green-earth-os.md #7452
• Run VS Code Spell Checker on guides-team.md #7453
• Run VS Code Spell Checker on heart.md #7454
• Run VS Code Spell Checker on hellogov.md #7455
• Run VS Code Spell Checker on home-unite-us.md #7456
• Run VS Code Spell Checker on hamburger-nav.html #7386
• Run VS Code Spell Checker on join-donate-card.html #7391
  Note: some spellcheck issues are not listed above - see the Issue Making Level 1 issues below

Dependencies/ Issue Making Level 1 issues

• Create spellcheck audit issues from line 81-90 of spreadsheet #6499
• Create spellcheck audit issues from line 91-100 of spreadsheet #6541
• Create spellcheck audit issues from line 101-109 of spreadsheet #6679
• Create spellcheck audit issues from line 110-117 of spreadsheet #6871
• Create spellcheck audit issues from line 118-125 of spreadsheet #7165
• Create spellcheck audit issues from line 126 - 133 of spreadsheet #7166
• Create spellcheck audit issues from line 134 - 142 of spreadsheet #7167
• Create spellcheck audit issues from line 143 - 149 of spreadsheet  #7587
• Create spellcheck audit issues from line 150 - 158 of spreadsheet #7168

Overview

We need to create issues to audit all appropriate codebase files for Code Spell Checker results. The HfLA spelling audit spreadsheet¹ will be used to track spell check audit issues, record false positives and misspellings, and track resulting issues for resolving errors.

Action Items

• Create HfLA spelling audit spreadsheet¹
  • List files we wish to spell check in Page Audit sheet
  • List excluded files/paths in Excluded Paths sheet
• Create an issue template for spell checking (Small) - see Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248 (comment)
• Create GitHub issue template - Create Issue Template for VSCode Spell Check Audit Issues #5540
• sample issue Run VSCode Code Spell Checker on _guide-pages/2FA.html #5311
  • Dev will install cSpell and will check the specified page
  • Errors will be recorded and categorized as misspellings or false positives
• Create Issue Making Level 1 issues to create issues and list above

Resources/Instructions

• This issue is part of Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349

Footnotes

1. HfLA spelling audit spreadsheet ↩ ↩²

[roslynwythe]

Draft Audit Issue Template

Title: Run VSCode Spell Checker on [INSERT FILE PATH]

### Overview
We need to audit HfLA codebase files for spelling errors using the VSCode Code Spell Checker extension in order to ensure site quality.  Results will be categorized as misspellings, false positives in the HfLA spelling audit spreadsheet[^1] and will be resolved in later issues.  

### Action Items
- [ ] You must use VS Code as your local text editor and install the `Code Spell Checker` VS Code extension[^2]  
- [ ] Do not change any configuration settings or make any spell corrections
- [ ] Open the file '[INSERT FILE PATH]'and note any Code Spell Checker errors
- [ ] Locate the file in column A ("File") of the "Page Audit" sheet.  In the column labelled "Result Summary", select the appropriate option:  `No errors` or `At least one error`.  
- [ ] If at least one error was reported, copy/paste each cSpell message into a separate row in the `Results` sheet
- [ ] In each new row, select the appropriate value: `misspelling` or `false positive` from the "Result type" column.  A false positive is a term that is not a misspelling, but it is not recognized by the spell checker because it is a technical term, abbreviation, acronym, URL or proper noun (name of a person, place or organization).  
- [ ] Move this issue to the Questions/In Review column and apply the label 'ready for dev lead`

### Merge Team
- [ ] After this issue is closed, release the dependency on this issue in #5248
- [ ] After the last dependency has been released, close that issue. 

### Resources/Instructions
- This issue is part of #5248
[^1]: [HfLA spelling audit spreadsheet - Results](https://docs.google.com/spreadsheets/d/1c2C9zUF_LsLGrnJN_LAlPV4UObz-nYffJyOiB_M6oI0/edit#gid=69989048)
[^2]:The recommended installation method is to install Code Spell Checker directly from the VS Code text editor, and those instructions can be found [here](https://code.visualstudio.com/learn/get-started/extensions). The extension can also be installed via the VS Code Marketplace website [here](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker). 

[ExperimentsInHonesty]

@essencegoff remove the extra mention of the issue on the results page if it appears on the audit page

[HackforLABot]

@roslynwythe, @essencegoff

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.

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

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 22, 2024 at 12:04 AM PST.}