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

• Identify where quotes are required in project-profile-card-review-and-update.yml
• Use tools or manually review to find missing or incorrect quotes.
• Choose and stick to a consistent quote style (single or double).
• Create simple guidelines for your team to follow.

Resources

• This Issue comes from this ER ER: Sometimes we use quotes around text in .md files and sometimes we don't #7540
• code search for markdown files
• code search for HTML files
• code search for YML files

[ExperimentsInHonesty]

@codyyjxn

• when you are done drafting this issue. Add a ready for prioritization label to it.
• I will take a look and see if we are ready to make the epic issue that would use these recommendations. See plan ER: Sometimes we use quotes around text in .md files and sometimes we don't #7540 (comment)

[ExperimentsInHonesty]

@codyyjxn I think you missed what you were supposed to do for this issue.

1. write this issue so that it has action items that achieve the scope listed in the 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.

The current draft of the action items, tell the person to make the changes, which is premature given that no one has done the research and recommendations yet. I am not asking you to do the research and recommendations, but rather write an issue for someone to do it.

[codyyjxn]

@codyyjxn I think you missed what you were supposed to do for this issue.

1. write this issue so that it has action items that achieve the scope listed in the 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.

The current draft of the action items, tell the person to make the changes, which is premature given that no one has done the research and recommendations yet. I am not asking you to do the research and recommendations, but rather write an issue for someone to do it.

Got it! Thank you Bonnie!

[codyyjxn]

@bonniewolfe Hi bonnie I have changed the instructions. I will attend todays meeting as well.

[codyyjxn]

@bonniewolfe How can I get some more guidance on this ?