Epic: Create template, spreadsheet and list of issues for quotations usage audit #8856

Dependency (Small issues)

• [ ]

Overview

We need to create issues to audit all codebase MD/YML files for the appropriate usage of quotations, in line with the recommendation on best practices outlined in #7540. The HfLA quotation audit spreadsheet (to be created) will be used to track quotation audit issues, record false positives, and track resulting issues for resolving errors.

More Details

Our Markdown and YAML files should contain single quotes only around strings containing special characters or other data types i.e. numbers or Booleans that we want to treat as strings. This will involve removing some existing unnecessary quotes and possibly changing some double quotes to single.

We need to create an Epic issue to audit the .md and .yml files in our codebase for the following:

• Unnecessary quotes
• Double quotes
• Missing quotes (in particular, some URLs with colons are missing quotes)

Action Items

• Create HfLA quotation audit spreadsheet (and include link as a resource below)
  • List files we wish to check quotation usage for in Page Audit sheet
  • List excluded files/paths in Excluded Paths sheet - Some files may be excluded from the audit if they use Markdown only for formatting, e.g. CONTRIBUTING.md and GHA comment templates.
  • Create an additional sheet for auditors to fill in results. Columns will include the file path, the code snippet containing quotes, a true/false selector for indicating whether the quote is necessary, and a note column to provide more information
• In a comment on this issue, draft an issue template for checking quotation usage in an individual file (Small)
  • Write some sample cases of variables that should and should not be in quotes to include or link in the template
  • Create an issue to make the template - Link here when created
• In a comment on this issue, draft an issue template for an Issue Making Level 1 issue to create a batch of issues to check individual files
  • Create an issue to make the template - Link here when created
• Create Issue Making Level 1 issues (used to to create individual issues) and list this issue as the parent
• Generate small issues and list above in dependency section

Resources/Instructions

• Full info on research and recommendation: Research and recommend best practice for using quotes around text in .md files #7565
  Searches for locating files to be audited:
• Markdown single quotes
• Markdown double quotes
• YAML single quotes
• YAML double quotes