search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 40 forks source link

Custom wordlist update #95

Closed ColmBhandal closed 1 year ago

ColmBhandal commented 1 year ago

Added some words to the custom wordlist. Many of them are Canonical specific. Some acronyms.

Only common words that are likely to be used by most should be accepted.

The words added are not supposed to be exhaustive.

ColmBhandal commented 1 year ago

I don't think we should put anything in here that is controversial. Those are decisions that should be made by each project. Alternatively, we could create a terminology list for all of Canonical (that would be the best), but then we'll need to discuss and agree.

I agree - if there's any controversy over something, best to remove it. Only keep things that everyone agrees on. I removed all the controversial entries.

ru-fu commented 1 year ago

@ColmBhandal This update (adding some common terms to the wordlist) could go in the changelog imo - can you add it?

ColmBhandal commented 1 year ago

@ColmBhandal This update (adding some common terms to the wordlist) could go in the changelog imo - can you add it?

Yep done: https://github.com/canonical/sphinx-docs-starter-pack/wiki/Change-log.