Improve spellcheck

[stevepiercy]

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

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

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

This issue must wait for https://github.com/plone/volto/issues/4416 to be resolved before work can start.

To improve spellcheck, add words to styles/Vocab/Plone/accept.txt and styles/Vocab/Plone/reject.txt.

See also:

• https://6.docs.plone.org/contributing/documentation/setup-build.html#vale
• https://github.com/plone/documentation/issues/1190

[ArslanYM]

Can I work on this issue @stevepiercy ?

[stevepiercy]

@ArslanYM you do not need to ask to work on any project under the Plone organization. Usually you can just start working. That is the nature of open source software.

To avoid potentially duplicating work, check to see if anyone has been assigned to the issue, or has done work on it under Pull Requests. You should also check to see if things have changed since the original issue was created. This one has changed, and I updated the description.

For the related issue in plone/documentation, we now use Vale for spellcheck. We need to do the same here in Volto before you can start work on this issue.

Finally see how to contribute: https://6.docs.plone.org/contributing/index.html

[utkkkarshhh]

Hi, can you please tell what's the purpose of reject.txt file? Does it contains the terms one must not use i.e "javascript, js, nodejs node". Thanks

[stevepiercy]

See docs: https://vale.sh/docs/topics/vocab/

[Abro0058T]

@stevepiercy https://6.docs.plone.org/contributing/setup-build.html#vale this link is not broken. If the issue is still open i would like to work on this

[stevepiercy]

@Abro0058T link updated to https://6.docs.plone.org/contributing/documentation/setup-build.html#vale in description. The green "Open" icon means this issue is still open.

[Abro0058T]

@stevepiercy i have setup the documentation repo but on running make vale command its showing command not found and with make docs-vale its showing no rule to make also i am running these command in documentation folder

[stevepiercy]

@Abro0058T thanks for reporting that. I think that's because you are in /documentation, but need to be in /documentation/submodules/volto to run the make docs-* commands in Volto only.

I need to update this document, too, to clarify that. https://6.docs.plone.org/volto/contributing/documentation.html

[Abro0058T]

@stevepiercy yes the command working now , in volto folder i required to install yarn using gtihub release (For linux only) and after that the command worked

Edit:- it's not yarn it's vale

[stevepiercy]

Yarn is not required to build Volto's docs or run Vale.

[stevepiercy]

@Abro0058T hmm... maybe I should change this: https://6.docs.plone.org/volto/contributing/documentation.html#docs-vale What would you suggest for an improvement?

Oh, and actually, maybe I should switch from a manual installation to automatic installation via our docs-requirements.txt with https://github.com/daniperez/vale-python-package?tab=readme-ov-file#installation.

[stevepiercy]

Yup, that's what I'm a-gonna do. See https://github.com/plone/documentation/pull/1591. Thanks for nudge!

[Abro0058T]

@stevepiercy i setup-ed and run the command make docs-vale , yesterday it was working but now its showing this error ( command not found )

[stevepiercy]

You need to update your branch with main.

You also might need to run this command from the same location to install vale inside your virtual environment.

bin/pip install -r requirements-docs.txt

Normally that would not be necessary, but I just made this change last night. Please let me know. Thank you!