HDDS-10667. Improvements to spelling checks.

[errose28]

What changes were proposed in this pull request?

• Add some terms that were missed in the initial commit of spelling capitalization checking configuration files.
• Add a link to docs on fixing false positive spelling errors in the job failure output
  • The output on the main workflow summary page is not easy to find.

What is the link to the Apache Jira?

HDDS-10667

How was this patch tested?

• Failing run
  • Note that all variants of "mis-replicate" are now allowed, but "mis" on its own is not, which correctly fails the run.
  • New output is more spread out and links to the contributing guide for resolving spelling issues.
• Passing run with spelling error fixed
  • This verifies the changes to the handling of the http acronym in the Apache license headers.

[adoroszlai]

I think misreplication is one word, similar to other words with mis- prefix.

CC @sodonnel

[sodonnel]

Seems like it should be, although I think we have used mis-replicated in some headings in the source code. Eg the RM report has Mis-Replicated containers. I think we may have carried the spelling over from HDFS which I think spells it the same way.

[errose28]

I actually saw the same wikipedia page when I was looking this up. The point of these configs is to make sure we use consistent spelling and capitalization of terms throughout the docs, so this is where we can decide whether we want to use misreplication or mis-replication across the whole site. cspell also doesn't recognize misreplication so we can choose one to add and the other will be flagged as incorrect.

[errose28]

As for which one to use, I'm not sure I have a preference. Misreplication looks more correct, although it would be used with overreplication and underreplication which look a little strange. As Stephen said, I'm pretty sure code and CLI output uses mis-replication, over-replication, and under-replication, so maybe it would be easiest just to keep using those?

[sodonnel]

Saying as the code has mis-replication, I am happy to go with that. Otherwise we are going to have to make code changes just to facilitate the docs.

[errose28]

Ok let's keep "mis-replication". "overreplication" and "underreplication" will already be flagged. CSpell doesn't support matching on spaces so we can't forbid "over replication" in favor of "over-replication" with cspell, although I could just add a grep at the end of the spelling.sh file that does this.

[errose28]

@adoroszlai @sodonnel are you ok with the spellings proposed in this PR, or do we need to discuss more? Currently the following are considered "correct":

• over-replicat{ed,ion}
• under-replicat{ed,ion}
• mis-replicat{ed,ion}
• quasi-close{d}

[sodonnel]

I am good with the hyphen separated words as we have them in the code already.

[adoroszlai]

are you ok with the spellings proposed in this PR?

I guess I can live with them. :)

[errose28]

Thanks for the reviews. If we need to revisit the plain-text versions of some of our Ozone terms in the future we can always use some combination of cspell and grep to fix and enforce changes in the future.