>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3423402. --> Reported by: [jonathan1055](https://www.drupal.org/user/92645) Related to !152 >>> <p>GitLab Templates has a <a href="https://project.pages.drupalcode.org/gitlab_templates/" title="documentation">documentation site</a> with details of how to run and customise each job. Here is the <a href="https://project.pages.drupalcode.org/gitlab_templates/jobs/cspell/" title="CSPELL">CSPELL job page</a>.</p> <p>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 <a href="https://app.slack.com/client/T06GX3JTS/CGKLP028K" title="#gitlab channel">#gitlab channel on Drupal Slack</a></p> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>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 <a href="https://www.drupal.org/node/3356364">https://www.drupal.org/node/3356364</a> and links to various pages on <a href="https://cspell.org">https://cspell.org</a></p> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <p>The page updated via this MR can be viewed here:<br> <a href="https://git.drupalcode.org/issue/gitlab_templates-3423402/-/blob/3423402-cspell-doc-page/docs/jobs/cspell.md">https://git.drupalcode.org/issue/gitlab_templates-3423402/-/blob/3423402-cspell-doc-page/docs/jobs/cspell.md</a></p> <p>Things to cover:</p> <ul> <li>How to use _CSPELL_WORDS, _CSPELL_IGNORE_PATHS and _CSPELL_EXTRA variables [done]</li> <li>Artifact file of unrecognized words [done]</li> <li>Artifact file txt version of .cpell.json for download to allow total customisation [done]</li> <li>Hints on how to disable a single file, part of a file or single lines, with cspell-ignore comments, etc [done]</li> <li>predefined defaults such as MinWordLength: 4 [done]</li> <li>Avoid running the job using SKIP_CSPELL [done]</li> </ul> > Related issue: [Issue #3422323](https://www.drupal.org/node/3422323) > Related issue: [Issue #3425649](https://www.drupal.org/node/3425649) > Related issue: [Issue #3423238](https://www.drupal.org/node/3423238)