Document how to use the CSPELL job
GitLab Templates has a documentation site with details of how to run and customise each job. Here is the CSPELL job page.
If you have any questions about the documentation or notice things that are wrong, incomplete or could be explained better, please add a comment to this issue, or ask in the #gitlab channel on Drupal Slack
Problem/Motivation
The CSPELL job will be a new feature to many contrib maintainers. We need to document how to use it, probably a combination of short explanations and examples on https://www.drupal.org/node/3356364 and links to various pages on https://cspell.org
Remaining tasks
The page updated via this MR can be viewed here:
https://git.drupalcode.org/issue/gitlab_templates-3423402/-/blob/3423402-cspell-doc-page/docs/jobs/cspell.md
Things to cover:
- How to use _CSPELL_WORDS, _CSPELL_IGNORE_PATHS and _CSPELL_EXTRA variables [done]
- Artifact file of unrecognized words [done]
- Artifact file txt version of .cpell.json for download to allow total customisation [done]
- Hints on how to disable a single file, part of a file or single lines, with cspell-ignore comments, etc [done]
- predefined defaults such as MinWordLength: 4 [done]
- Avoid running the job using SKIP_CSPELL [done]
Related issue: Issue #3422323
Related issue: Issue #3425649
Related issue: Issue #3423238