chore: add file type reference rule (#2284)

* chore: add file type reference rule * add more file types * change compressed file types to uppercase * fix format --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
spectrocloud · Mar 1, 2024 · 0fdcdb0 · 0fdcdb0
1 parent 95fc8ef
commit 0fdcdb0
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 11 deletions.
diff --git a/docs/docs-content/tenant-settings/api-key-management.md b/docs/docs-content/tenant-settings/api-key-management.md
@@ -11,22 +11,22 @@ tags: ["tenant-administration", "authentication", "api-key"]
 You can manage API keys for your Palette tenant. API keys are used to authenticate API requests to Palette. You can
 create, edit, revoke, and delete API keys for your tenant.
 
-Unlike user accounts, tenant administrators can view all API keys created for the tenant. Users are
-limited to actions for their own API keys.
+Unlike user accounts, tenant administrators can view all API keys created for the tenant. Users are limited to actions
+for their own API keys.
 
 The following table describes the API key management tasks you can perform as a tenant administrator, and how they
 differ from users.
 
 | **Action**          | **Description**                                   | **Tenant Admin** | **User** |
-| ------------------- | ------------------------------------------------- | ---------------- | ------------------- |
-| **List**            | List all API keys in the tenant.                  | ✅               | ❌                  |
-| **Create**          | Create a new API key.                             | ✅               | ✅                  |
-| **Create for User** | Create a new API key for a different user.        | ✅               | ❌                  |
-| **Edit**            | Edit an existing API key.                         | ✅               | ✅                  |
-| **Revoke**          | Revoke an existing API key.                       | ✅               | ✅                  |
-| **Delete**          | Delete an existing API key.                       | ✅               | ✅                  |
-| **Reassign**        | Reassign an existing API key to a different user. | ❌               | ❌                  |
-| **View**            | View the sensitive API key value.                 | ❌               | ❌                  |
+| ------------------- | ------------------------------------------------- | ---------------- | -------- |
+| **List**            | List all API keys in the tenant.                  | ✅               | ❌       |
+| **Create**          | Create a new API key.                             | ✅               | ✅       |
+| **Create for User** | Create a new API key for a different user.        | ✅               | ❌       |
+| **Edit**            | Edit an existing API key.                         | ✅               | ✅       |
+| **Revoke**          | Revoke an existing API key.                       | ✅               | ✅       |
+| **Delete**          | Delete an existing API key.                       | ✅               | ✅       |
+| **Reassign**        | Reassign an existing API key to a different user. | ❌               | ❌       |
+| **View**            | View the sensitive API key value.                 | ❌               | ❌       |
 
 :::warning
 

diff --git a/vale/styles/spectrocloud/file-type.yml b/vale/styles/spectrocloud/file-type.yml
@@ -0,0 +1,22 @@
+extends: substitution
+message: "Incorrect file type reference. Use '%s'."
+level: error
+ignorecase: false
+swap:
+  csv file: CSV file
+  iso file: ISO file
+  iso image: ISO image
+  json file: JSON file
+  md file: Markdown file
+  pdf file: PDF file
+  png file: PNG file
+  py file: Python file
+  svg file: SVG file
+  tar file: TAR file
+  tf file: Terraform file
+  tgz file: TGZ file
+  txt file: text file
+  yaml file: YAML file
+  ZIP file: zip file
+  zst file: ZST file
+