Draft: Attempt a bare-bones Hunspell dictionary
What does this MR do?
Attempts to create the barest of bare-bones Hunspell dictionary to extend the en_us dictionary.
Resources:
- https://vale.sh/docs/checks/spelling
- https://vale.sh/docs/vale-ini
- I took naming conventions from https://www.oxygenxml.com/doc/versions/27.0/ug-editor/topics/add-Hunspell-dictionary.html (dictionary name
en_us+ hyphen + descriptor of the custom dictionary)
I'm using doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md as a file to try. It has several brand names in a list. I removed the wrapper for spelling exceptions around the list, and added those terms to the .dic file.
I can't figure out why gitlab_base/Spelling isn't using this dictionary. I have to be doing something wrong, but I don't know where.
Related issues
- Related to https://gitlab.com/gitlab-com/legal-and-compliance/-/issues/2487+
- Related to Update spelling and capitalization linting in t... (#473892)
- Related to Productionize GitLab's use of Vale (gitlab-org/technical-writing/team-tasks#1251 - closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"~"backend"~"type::bug"~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior, say something likeDefault behavior when you close an issue. -
The headings (other than the page title) should be active. Instead of Configuring GDK, say something likeConfigure GDK. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.