search

canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation
Apache License 2.0
48 stars 28 forks source link

Launchpad: fix spelling issues #77

Open jugmac00 opened 3 weeks ago

jugmac00 commented 3 weeks ago

Documentation: https://documentation.ubuntu.com/launchpad/en/latest/how-to/ GitHub repo: https://github.com/canonical/launchpad-manual Contribution guide: https://documentation.ubuntu.com/launchpad/en/latest/contribute-to-our-docs/

For the migration of the documentation, a lot of existing documentation was transferred from other platforms, where no checks were performed before. Some of the added pages were excluded from the new spellchecks.

Task: remove the exceptions one by one from https://github.com/canonical/launchpad-manual/blob/main/.sphinx/spellingcheck.yaml (e.g. |!_build/explanation/javascript-integration-testing/index.html), run the spell checks (make spelling), fix the spelling errors and/or include new words to https://github.com/canonical/launchpad-manual/blob/main/.custom_wordlist.txt, and create a pull request, preferably one for each page to make reviews easier. We use British English at Canonical.

gerryRcom commented 2 weeks ago

Hi jugmac00, I can give this a go if no one is currently working on it?

jugmac00 commented 2 weeks ago

@gerryRcom That would be fantastic 😊

gerryRcom commented 2 weeks ago

Great, I'll get the first change in shortly to make sure I'm on the right track. I'm not sure if I picked a bad first page but there seems to be a lot of "new" words to add to the custom word file.

jugmac00 commented 2 weeks ago

It is entirely possible that a lot of new words need to be added, but it should get better with every new article. Also, it is definitely possible that there are some typos.

Thanks for looking into this. Highly appreciated 👍