Create .valeignore

[MarcusSorealheis]

we need to leave the blog's voice unemcumbered.

---

This change is 

[aaronmondal]

You can disable vale already directly in the blogs via around the scopes that trigger vale, e.g via <!-- vale Style.Rule = NO --> and <!-- vale Style.Rule = YES -->.

See: https://vale.sh/docs/topics/config/#markdown-amp-html

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: 0 of 1 LGTMs obtained, and all files reviewed, and pending CI: Coverage, Installation / macos-13, Installation / macos-14, Remote / large-ubuntu-22.04, macos-13

[MarcusSorealheis]

I don't think Vale is for blogs.

[aaronmondal]

I don't think Vale is for blogs.

Some style issues are certainly not good for blogs, but we largely disabled those globally already. The errors that trigger are mostly to correct spelling mistakes. Almost all cases fall under one of these categories:

• Contractions like "that is" -> "that's"
• Spelling issues for programs where the warnings should be read as "sometool" -> "sometool"
• Words that are correct but vale isn't aware of (e.g CUDA, LLVM, etc) which we can add to https://github.com/TraceMachina/nativelink/blob/main/.github/styles/config/vocabularies/TraceMachina/accept.txt

If we add global vale ignores we run the risk of introducing typos in these documents, which I'd argue would be worse than the slight inconvenience sometimes caused by the warnings.

Also note that the language that we "enforce" here is harder to generate via LLMs. In other words, vale-linted documents have a higher chance to look "human" to search engines.

[SchahinRohani]

Every writer has his own writing style. I am not sure if it's good to force those writers with vale to change their style.
A global .valeignore could be a good solution to this...

[MarcusSorealheis]

Vale for blogs is not a slight inconvenience and contractions are a feature of literature, not a bug. A blog is somewhere in the middle of reference and literature.

…

On Thu, Oct 31, 2024 at 19:19 Schahin ***@***.***> wrote: Every writer has his own writing style. I am not sure if it's good to force those writers with vale to change their style. A global .valeignore could be a good solution to this... — Reply to this email directly, view it on GitHub <#1447 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAR6TSHUABSIJWMD6HDUEDLZ6LQJ7AVCNFSM6AAAAABQ7I563GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJRGE3DQMJRGM> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[aaronmondal]

After looking into this more I think I found a way that could make everyone happy here.

This file is the one that configures styles:

nativelink/.vale.ini

Lines 1 to 27 in 8a3869c

	StylesPath = .github/styles
	# TODO(aaronmondal): Set this to `warning`, then to `suggestion` once Vale
	# stabilizes in CI.
	MinAlertLevel = error
	Vocab = TraceMachina
	Packages = alex, Microsoft, write-good
	[formats]
	mdx = md
	[*.{md,mdx}]
	BasedOnStyles = alex, Vale, Microsoft, write-good
	# Ignore code blocks in Starlight's TabItems.
	BlockIgnores = (?s)(<TabItem.*?>.*?```.*?```.*?</TabItem>)
	# Ignore filesnames and director names in tree visualizations.
	BlockIgnores = (?s)(<FileTree>.*?</FileTree>)
	# Too harsh. The `write-good.Passive` check already covers many cases.
	write-good.E-Prime = NO
	# Redundant. Covered by `write-good.Passive`.
	Microsoft.Passive = NO

Note the [*.{md,mdx}] section. I believe if we add a section like [path/to/blogposts/*.{md,mdx}] we can disable things like contractions "globally" for blogs but keep the typo checking intact. Would that work? I totally get that we shouldn't enforce strict style in freeform text, just trying to prevent things like actual typos and to ensure that if we use "unusual" words that we add them to the accept.txt file and/or use backticks correctly where appropriate.