Research and recommend best practice for using quotes around text in .md files

[codyyjxn]

Overview

We need to research and recommend best practice so that we can audit the site to determine which quotes or lack of quotes need to be fixed.

Details

Here is an example of two text items in the same file.

https://github.com/hackforla/website/blob/gh-pages/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml?plain

website/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml

Line 224 in 271a82e

label: "Update Slack Link?"

website/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml

Line 233 in 271a82e

label: Slack Link

Here are examples from two different project .md files. Notice that first one one uses a double quote and the second uses a single quote for the same type of link

website/_projects/food-oasis.md

Line 90 in 53e798a

url: "https://github.com/hackforla/food-oasis"

website/_projects/100-automations.md

Line 53 in 53e798a

url: 'https://github.com/100Automations/website'

Action Items

• Review .md and .yml files in the repository containing quotes and identify:
  • What types of data are currently put in quotes
  • Where the data in quotes is being used (to generate an HTML page, in an issue template, etc.)
• Research best practices for using quotes within .md/.yml files and any other files that pull quoted data from the .md/.yml files
• Write a comment on this issue with a recommendation for how quotes should be used in .md/.yml files, including:
  • Types of data that should be in quotes, if any
  • Whether single or double quotes should be used
  • Brief explanation of your research findings and justification for your recommendations
• Finalize recommendations with a team lead

Additional Notes

Some research was already done for this issue and can be found in the comments, but it needs to be compiled into a concise recommendation. Additional research may be required.

Resources

• This Issue comes from this ER ER: Sometimes we use quotes around text in .md files and sometimes we don't #7540
• Markdown single quotes
• Markdown double quotes
• YAML single quotes
• YAML double quotes

[github-actions]

Hi @codyyjxn.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:

• Feature

NOTE: Please ignore this comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards.
To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

• Wiki: How to create issues
• Wiki: How to read and interpret labels