Investigate method for excluding blocks of text in markdown from spell checking

[roslynwythe]

Overview

As developers we need to investigate methods for excluding blocks of text in markdown files from spell checking, in order to avoid large numbers of false positives

Details

For HTML and JavaScript files, it is possible to exclude a portion of the text from spell checking, using specially formatted comments. Examples of such comments can be found here in the cspell documentation. However for markdown files the situation is different because since markdown does not support "comments", it is not clear which if any of those those methods can be used

Action Items

• [ ] Read cspell - enable/disable checking sections of code and determine whether the techniques presented can be used in a markdown file. As a sample use the overview section of _guide-pages/how-to-set-reminders-in-slack.md
• [ ] If successful and no "unknown word" warnings are generated by VS Code Spell Check Extension
  • [ ] verify the proper operation of the markdown text by checking the web page ??
  • [ ] add and commit _guide-pages/how-to-set-reminders-in-slack.md
  • [ ] in a comment in this issue, create a draft wiki page describing the method
• [ ] If no method is found, create a comment detailing the research/testing in a comment in this issue, then move the issue to "Questions/In Review" column and apply "ready for dev lead" label

Resources

cspell - enable/disable checking sections of code

• This issue resulted from #7004

[github-actions[bot]]

Hi @roslynwythe.

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

• Complexity, Role, Feature, Size

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

[roslynwythe]

@ExperimentsInHonesty I'm not sure it makes sense to proceed with this issue, since the markdown file is not in production and we wouldn't expect any page with Lorem ipsum placeholder text to be in production. Perhaps we should wait until we have a better sample case.

[ExperimentsInHonesty]

@roslynwythe If you want to wait, we can stick this in the icebox. Its up to you.

[roslynwythe]

@ExperimentsInHonesty I would like to wait until we have a better use case, in which we need to exclude a block of text from spell checking, but I can't think of another page on the website with that requirement, and I don't want to put it in the Ice Box without a meaningful dependency. So maybe I should close it as unplanned?

[ExperimentsInHonesty]

@roslynwythe ok, I am closing as unplanned.

[HackforLABot]

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 :)