From 51853b6ca9afe28a2a90c8850f2267ec6c5411fe Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:35:47 +0200 Subject: [PATCH 1/7] chore: move vale out from .github directory Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .vale.ini | 2 +- {.github/vale => _vale}/.vale-config/0-Hugo.ini | 0 {.github/vale => _vale}/Docker/Acronyms.yml | 0 {.github/vale => _vale}/Docker/Avoid.yml | 0 {.github/vale => _vale}/Docker/Capitalization.yml | 0 {.github/vale => _vale}/Docker/Exclamation.yml | 0 {.github/vale => _vale}/Docker/GenericCTA.yml | 0 {.github/vale => _vale}/Docker/HeadingLength.yml | 0 {.github/vale => _vale}/Docker/HeadingPunctuation.yml | 0 {.github/vale => _vale}/Docker/HeadingSentenceCase.yml | 0 {.github/vale => _vale}/Docker/ListComma.yml | 0 {.github/vale => _vale}/Docker/OxfordComma.yml | 0 {.github/vale => _vale}/Docker/RecommendedWords.yml | 0 {.github/vale => _vale}/Docker/SentenceLength.yml | 0 {.github/vale => _vale}/Docker/Spacing.yml | 0 {.github/vale => _vale}/Docker/URLFormat.yml | 0 {.github/vale => _vale}/Docker/Units.yml | 0 {.github/vale => _vale}/Docker/VersionText.yml | 0 {.github/vale => _vale}/Docker/We.yml | 0 {.github/vale => _vale}/config/vocabularies/Docker/accept.txt | 0 20 files changed, 1 insertion(+), 1 deletion(-) rename {.github/vale => _vale}/.vale-config/0-Hugo.ini (100%) rename {.github/vale => _vale}/Docker/Acronyms.yml (100%) rename {.github/vale => _vale}/Docker/Avoid.yml (100%) rename {.github/vale => _vale}/Docker/Capitalization.yml (100%) rename {.github/vale => _vale}/Docker/Exclamation.yml (100%) rename {.github/vale => _vale}/Docker/GenericCTA.yml (100%) rename {.github/vale => _vale}/Docker/HeadingLength.yml (100%) rename {.github/vale => _vale}/Docker/HeadingPunctuation.yml (100%) rename {.github/vale => _vale}/Docker/HeadingSentenceCase.yml (100%) rename {.github/vale => _vale}/Docker/ListComma.yml (100%) rename {.github/vale => _vale}/Docker/OxfordComma.yml (100%) rename {.github/vale => _vale}/Docker/RecommendedWords.yml (100%) rename {.github/vale => _vale}/Docker/SentenceLength.yml (100%) rename {.github/vale => _vale}/Docker/Spacing.yml (100%) rename {.github/vale => _vale}/Docker/URLFormat.yml (100%) rename {.github/vale => _vale}/Docker/Units.yml (100%) rename {.github/vale => _vale}/Docker/VersionText.yml (100%) rename {.github/vale => _vale}/Docker/We.yml (100%) rename {.github/vale => _vale}/config/vocabularies/Docker/accept.txt (100%) diff --git a/.vale.ini b/.vale.ini index f88084e158..c8101f4fb2 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .github/vale +StylesPath = _vale MinAlertLevel = suggestion Vocab = Docker diff --git a/.github/vale/.vale-config/0-Hugo.ini b/_vale/.vale-config/0-Hugo.ini similarity index 100% rename from .github/vale/.vale-config/0-Hugo.ini rename to _vale/.vale-config/0-Hugo.ini diff --git a/.github/vale/Docker/Acronyms.yml b/_vale/Docker/Acronyms.yml similarity index 100% rename from .github/vale/Docker/Acronyms.yml rename to _vale/Docker/Acronyms.yml diff --git a/.github/vale/Docker/Avoid.yml b/_vale/Docker/Avoid.yml similarity index 100% rename from .github/vale/Docker/Avoid.yml rename to _vale/Docker/Avoid.yml diff --git a/.github/vale/Docker/Capitalization.yml b/_vale/Docker/Capitalization.yml similarity index 100% rename from .github/vale/Docker/Capitalization.yml rename to _vale/Docker/Capitalization.yml diff --git a/.github/vale/Docker/Exclamation.yml b/_vale/Docker/Exclamation.yml similarity index 100% rename from .github/vale/Docker/Exclamation.yml rename to _vale/Docker/Exclamation.yml diff --git a/.github/vale/Docker/GenericCTA.yml b/_vale/Docker/GenericCTA.yml similarity index 100% rename from .github/vale/Docker/GenericCTA.yml rename to _vale/Docker/GenericCTA.yml diff --git a/.github/vale/Docker/HeadingLength.yml b/_vale/Docker/HeadingLength.yml similarity index 100% rename from .github/vale/Docker/HeadingLength.yml rename to _vale/Docker/HeadingLength.yml diff --git a/.github/vale/Docker/HeadingPunctuation.yml b/_vale/Docker/HeadingPunctuation.yml similarity index 100% rename from .github/vale/Docker/HeadingPunctuation.yml rename to _vale/Docker/HeadingPunctuation.yml diff --git a/.github/vale/Docker/HeadingSentenceCase.yml b/_vale/Docker/HeadingSentenceCase.yml similarity index 100% rename from .github/vale/Docker/HeadingSentenceCase.yml rename to _vale/Docker/HeadingSentenceCase.yml diff --git a/.github/vale/Docker/ListComma.yml b/_vale/Docker/ListComma.yml similarity index 100% rename from .github/vale/Docker/ListComma.yml rename to _vale/Docker/ListComma.yml diff --git a/.github/vale/Docker/OxfordComma.yml b/_vale/Docker/OxfordComma.yml similarity index 100% rename from .github/vale/Docker/OxfordComma.yml rename to _vale/Docker/OxfordComma.yml diff --git a/.github/vale/Docker/RecommendedWords.yml b/_vale/Docker/RecommendedWords.yml similarity index 100% rename from .github/vale/Docker/RecommendedWords.yml rename to _vale/Docker/RecommendedWords.yml diff --git a/.github/vale/Docker/SentenceLength.yml b/_vale/Docker/SentenceLength.yml similarity index 100% rename from .github/vale/Docker/SentenceLength.yml rename to _vale/Docker/SentenceLength.yml diff --git a/.github/vale/Docker/Spacing.yml b/_vale/Docker/Spacing.yml similarity index 100% rename from .github/vale/Docker/Spacing.yml rename to _vale/Docker/Spacing.yml diff --git a/.github/vale/Docker/URLFormat.yml b/_vale/Docker/URLFormat.yml similarity index 100% rename from .github/vale/Docker/URLFormat.yml rename to _vale/Docker/URLFormat.yml diff --git a/.github/vale/Docker/Units.yml b/_vale/Docker/Units.yml similarity index 100% rename from .github/vale/Docker/Units.yml rename to _vale/Docker/Units.yml diff --git a/.github/vale/Docker/VersionText.yml b/_vale/Docker/VersionText.yml similarity index 100% rename from .github/vale/Docker/VersionText.yml rename to _vale/Docker/VersionText.yml diff --git a/.github/vale/Docker/We.yml b/_vale/Docker/We.yml similarity index 100% rename from .github/vale/Docker/We.yml rename to _vale/Docker/We.yml diff --git a/.github/vale/config/vocabularies/Docker/accept.txt b/_vale/config/vocabularies/Docker/accept.txt similarity index 100% rename from .github/vale/config/vocabularies/Docker/accept.txt rename to _vale/config/vocabularies/Docker/accept.txt From bde3b3641d5fbc2e8835efa367fdd830f08f5967 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:36:18 +0200 Subject: [PATCH 2/7] vale: update Hugo config package Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/.vale-config/0-Hugo.ini | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/_vale/.vale-config/0-Hugo.ini b/_vale/.vale-config/0-Hugo.ini index 3b014081df..4347ca9e90 100644 --- a/_vale/.vale-config/0-Hugo.ini +++ b/_vale/.vale-config/0-Hugo.ini @@ -1,8 +1,10 @@ [*.md] # Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}}) TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \ -(\[.+\]\({{< .+ >}}\)) +(\[.+\]\({{< .+ >}}\)), \ +[^\S\r\n]({{[%<] \w+ .+ [%>]}})\s, \ +[^\S\r\n]({{[%<](?:/\*) .* (?:\*/)[%>]}})\s # Exclude `{{< myshortcode `This is some HTML, ... >}}` -BlockIgnores = (?sm)^({{[%<] [^{]*? [%>]}})\n$, \ +BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \ (?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}}) From 860df3228bb96a2726f2185429e0624504b5f92b Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:45:01 +0200 Subject: [PATCH 3/7] vale: improve Docker capitalizaton rule don't flag cases like: * moby/docker-ce-packaging * docker/docker Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/Docker/Capitalization.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_vale/Docker/Capitalization.yml b/_vale/Docker/Capitalization.yml index 2646d9c808..0b6ed0bb56 100644 --- a/_vale/Docker/Capitalization.yml +++ b/_vale/Docker/Capitalization.yml @@ -7,4 +7,4 @@ action: params: - Docker tokens: - - 'docker(?!/[a-z-]+)' + - '[^\[/]docker[^/]' From 73839ebf3f7555950f74cb90debd06f8e40a56c1 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:55:43 +0200 Subject: [PATCH 4/7] vale: don't flag alerts as acronyms > [!TIP] was being flagged as an undefined acronym Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/Docker/Acronyms.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_vale/Docker/Acronyms.yml b/_vale/Docker/Acronyms.yml index ce19d88246..2838e0d71f 100644 --- a/_vale/Docker/Acronyms.yml +++ b/_vale/Docker/Acronyms.yml @@ -4,7 +4,7 @@ link: https://docs.docker.com/contribute/style/grammar/#acronyms-and-initialisms level: warning ignorecase: false # Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' +first: '\b[^!]([A-Z]{3,5})\b' second: '(?:\b[A-Za-z]+(?: |\n))+\(([A-Z]{3,5})\)' # ... with the exception of these: exceptions: From ce9428886ca3bb1ff9095c7711d0779e09a8afe0 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:58:26 +0200 Subject: [PATCH 5/7] vale: add REST to acronyms Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/Docker/Acronyms.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_vale/Docker/Acronyms.yml b/_vale/Docker/Acronyms.yml index 2838e0d71f..c87f647ada 100644 --- a/_vale/Docker/Acronyms.yml +++ b/_vale/Docker/Acronyms.yml @@ -55,6 +55,7 @@ exceptions: - POST - RAM - REPL + - REST - RSA - SBOM - SCM From 3ecc6365711194c779b8a3cfef9adf120c20c054 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 16:00:32 +0200 Subject: [PATCH 6/7] vale: allow possessive noun form of Docker Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/config/vocabularies/Docker/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/_vale/config/vocabularies/Docker/accept.txt b/_vale/config/vocabularies/Docker/accept.txt index c461e2f7bf..f70d624a0b 100644 --- a/_vale/config/vocabularies/Docker/accept.txt +++ b/_vale/config/vocabularies/Docker/accept.txt @@ -35,6 +35,7 @@ Ddosify Debootstrap Dev Environments? Django +Docker's Docker Build Cloud Docker Business Docker Dasboard From 77695db5d13329c716d2026ab0092345118b5f0e Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 28 Aug 2024 16:01:49 +0200 Subject: [PATCH 7/7] chore: sort acronyms alphabetically Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/Docker/Acronyms.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_vale/Docker/Acronyms.yml b/_vale/Docker/Acronyms.yml index c87f647ada..337fe998a1 100644 --- a/_vale/Docker/Acronyms.yml +++ b/_vale/Docker/Acronyms.yml @@ -9,11 +9,10 @@ second: '(?:\b[A-Za-z]+(?: |\n))+\(([A-Z]{3,5})\)' # ... with the exception of these: exceptions: - API - - BIOS - - FUSE - ARM - ASP - AWS + - BIOS - CLI - CPU - CSS @@ -27,6 +26,7 @@ exceptions: - DVP - ELK - FAQ + - FUSE - GCC - GDB - GET