From 822c5e13d6d1a710f2f9c7fbaf48066f99050831 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Thu, 17 Oct 2024 08:54:46 -0400 Subject: [PATCH] Move vale configs into `docs/` (#47575) Organize vale prose linter configurations into the `docs` directory so automated workflows treat them as Teleport documentation changes. Otherwise, vale style changes are classified as code changes, which is not correct. --- .github/workflows/doc-tests.yaml | 1 + .vale.ini => docs/.vale.ini | 2 +- .../vale-styles/3rd-party-products/aws-vs-amazon.yml | 0 .../vale-styles/3rd-party-products/former-names.yml | 0 {.github => docs}/vale-styles/examples/teleport-accounts.yml | 0 {.github => docs}/vale-styles/messaging/capitalization.yml | 0 {.github => docs}/vale-styles/messaging/consistent-terms.yml | 0 {.github => docs}/vale-styles/messaging/edition-names.yml | 0 {.github => docs}/vale-styles/messaging/protocol-products.yml | 0 {.github => docs}/vale-styles/messaging/subjective-terms.yml | 0 {.github => docs}/vale-styles/structure/architecture-h2.yml | 0 {.github => docs}/vale-styles/structure/step-numbering.yml | 0 12 files changed, 2 insertions(+), 1 deletion(-) rename .vale.ini => docs/.vale.ini (78%) rename {.github => docs}/vale-styles/3rd-party-products/aws-vs-amazon.yml (100%) rename {.github => docs}/vale-styles/3rd-party-products/former-names.yml (100%) rename {.github => docs}/vale-styles/examples/teleport-accounts.yml (100%) rename {.github => docs}/vale-styles/messaging/capitalization.yml (100%) rename {.github => docs}/vale-styles/messaging/consistent-terms.yml (100%) rename {.github => docs}/vale-styles/messaging/edition-names.yml (100%) rename {.github => docs}/vale-styles/messaging/protocol-products.yml (100%) rename {.github => docs}/vale-styles/messaging/subjective-terms.yml (100%) rename {.github => docs}/vale-styles/structure/architecture-h2.yml (100%) rename {.github => docs}/vale-styles/structure/step-numbering.yml (100%) diff --git a/.github/workflows/doc-tests.yaml b/.github/workflows/doc-tests.yaml index cc5acd19fe25..5030bebe367b 100644 --- a/.github/workflows/doc-tests.yaml +++ b/.github/workflows/doc-tests.yaml @@ -120,4 +120,5 @@ jobs: # changed files. filter_mode: added fail_on_error: true + vale_flags: "--config=docs/.vale.ini" diff --git a/.vale.ini b/docs/.vale.ini similarity index 78% rename from .vale.ini rename to docs/.vale.ini index a780ee1b01f2..9620898c3adb 100644 --- a/.vale.ini +++ b/docs/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .github/vale-styles +StylesPath = vale-styles MinAlertLevel = suggestion [formats] diff --git a/.github/vale-styles/3rd-party-products/aws-vs-amazon.yml b/docs/vale-styles/3rd-party-products/aws-vs-amazon.yml similarity index 100% rename from .github/vale-styles/3rd-party-products/aws-vs-amazon.yml rename to docs/vale-styles/3rd-party-products/aws-vs-amazon.yml diff --git a/.github/vale-styles/3rd-party-products/former-names.yml b/docs/vale-styles/3rd-party-products/former-names.yml similarity index 100% rename from .github/vale-styles/3rd-party-products/former-names.yml rename to docs/vale-styles/3rd-party-products/former-names.yml diff --git a/.github/vale-styles/examples/teleport-accounts.yml b/docs/vale-styles/examples/teleport-accounts.yml similarity index 100% rename from .github/vale-styles/examples/teleport-accounts.yml rename to docs/vale-styles/examples/teleport-accounts.yml diff --git a/.github/vale-styles/messaging/capitalization.yml b/docs/vale-styles/messaging/capitalization.yml similarity index 100% rename from .github/vale-styles/messaging/capitalization.yml rename to docs/vale-styles/messaging/capitalization.yml diff --git a/.github/vale-styles/messaging/consistent-terms.yml b/docs/vale-styles/messaging/consistent-terms.yml similarity index 100% rename from .github/vale-styles/messaging/consistent-terms.yml rename to docs/vale-styles/messaging/consistent-terms.yml diff --git a/.github/vale-styles/messaging/edition-names.yml b/docs/vale-styles/messaging/edition-names.yml similarity index 100% rename from .github/vale-styles/messaging/edition-names.yml rename to docs/vale-styles/messaging/edition-names.yml diff --git a/.github/vale-styles/messaging/protocol-products.yml b/docs/vale-styles/messaging/protocol-products.yml similarity index 100% rename from .github/vale-styles/messaging/protocol-products.yml rename to docs/vale-styles/messaging/protocol-products.yml diff --git a/.github/vale-styles/messaging/subjective-terms.yml b/docs/vale-styles/messaging/subjective-terms.yml similarity index 100% rename from .github/vale-styles/messaging/subjective-terms.yml rename to docs/vale-styles/messaging/subjective-terms.yml diff --git a/.github/vale-styles/structure/architecture-h2.yml b/docs/vale-styles/structure/architecture-h2.yml similarity index 100% rename from .github/vale-styles/structure/architecture-h2.yml rename to docs/vale-styles/structure/architecture-h2.yml diff --git a/.github/vale-styles/structure/step-numbering.yml b/docs/vale-styles/structure/step-numbering.yml similarity index 100% rename from .github/vale-styles/structure/step-numbering.yml rename to docs/vale-styles/structure/step-numbering.yml