Documentation: replacing 'hole' with 'vulnerability' or 'flaw'
Hi,
In commit 83156296, the Documentation style guide suggested to avoid the use of the word 'hole' and instead use 'vulnerability'.
However, the website is full of references to 'hole'. See this page alone: https://tails.boum.org/security/ It has 108 such references.
I would be happy to replace all the cases of 'hole', however:
-
Replacing it with 'vulnerability' in a mass update script would make certain lines in markdown pages longer. Could we use 'flaw' instead, as it's the same length word (including when pluralised)? However, it might have similar implications for translations. You might also find 'flaw' to be as obscure as 'hole', I'm not sure.
-
Lots of actual pages have the name 'hole' in their URL (all those 'Numerous security holes in...' changelog pages). I realised that if the pages were renamed, that might lead to a lot of 404s. I imagine it would be a lot of effort required to implement redirects from the old URLs to the new ones. However, a sysadmin could implement some sort of regex rewrite of 'hole' to 'vulnerability' in your vhost config file, assuming there are no other words in URLs such as 'whole' which might get caught up in such a rewrite.
Particularly because of 2), I am wondering if it would be simpler to actually allow the use of the word 'hole', just so you aren't conflicting with your own style guide :) (However, I agree that 'hole' is indeed not the best word).
If, however, you don't care about maintaining redirects if the file names were changed to not have 'hole' but 'vulnerability' or 'flaw', I would be happy to volunteer to work on this.
Thanks!