plone / plone/documentation

Improve spellcheck

Open
#1,190 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

31 needs: help 33 needs: docs 41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest 99 tag: Plone 6.x
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

It would be good to improve spellcheck and consistency of spellings. For example:

JavaScript, instead of javascript / Javascript / js
Node.js, instead of nodejs / NodeJS / node

Use caution when doing global find and replaces to not overwrite commands or code blocks that use those strings.

To improve spellcheck, add words to:

  • styles/config/vocabularies/Plone/accept.txt
  • styles/config/vocabularies/Plone/reject.txt

Note that when you add a correct spelling in accept.txt, then you do not need to add incorrect casings of the same term to reject.txt. See https://vale.sh/docs/keys/vocab#case-sensitivity.

Vale usage

Contributing

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with styles/config/vocabularies/Plone/accept.txt and reject.txt, then review the documentation for Vale usage and the linked documentation pages for spelling inconsistencies. Update vocabulary entries and affected documentation carefully, avoiding commands and code blocks; done means consistent spellings with correct terms accepted and incorrect casings rejected where needed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.