chore: add vale rule for product UI naming (#2044)

* add product ui rule * test non-preferred terms * fix syntax issues * modify error message * add drop-down menu entry * remove test terms * Update vale/styles/spectrocloud/product-ui.yml Co-authored-by: Karl Cardenas <[email protected]> --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
spectrocloud · Jan 17, 2024 · 38000f7 · 38000f7
1 parent 9894100
commit 38000f7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/docs/docs-content/glossary-all.md b/docs/docs-content/glossary-all.md
@@ -193,4 +193,4 @@ An application running on the Kubernetes cluster is called a Workload. It can be
 Workload / Tenant / Application Clusters are a collection of master and worker nodes that cooperate to execute container application workloads. Kubernetes clusters provisioned by users are referred to as Workload Clusters. These clusters are created within [projects](#project) and they are provisioned and managed in the user's cloud environment. Each cluster is provisioned from a [Cluster Profile](#cluster-profile) with additional configuration overrides and cloud-specific settings.
 ## Workspace
 
-The multi-cluster management and governance capabilities are supervised with Palette Workspaces. Workspaces enable the logical grouping of clusters and namespaces to provide application or team-specific governance and visibility into workloads, cost, and usage metrics. For example, the application or team workload may be deployed into namespaces across clusters for achieving High Availability (HA), Disaster Recovery (DR), organization-specific placement policies, etc. Grouping the namespaces and clusters into a workspace provide central management and governance in a multi-cluster distributed environment.
+The multi-cluster management and governance capabilities are supervised with Palette Workspaces. Workspaces enable the logical grouping of clusters and namespaces to provide application or team-specific governance and visibility into workloads, cost, and usage metrics. For example, the application or team workload may be deployed into namespaces across clusters for achieving High Availability (HA), Disaster Recovery (DR), organization-specific placement policies, etc. Grouping the namespaces and clusters into a workspace provide central management and governance in a multi-cluster distributed environment.
diff --git a/vale/styles/spectrocloud/product-ui.yml b/vale/styles/spectrocloud/product-ui.yml
@@ -0,0 +1,12 @@
+extends: substitution
+message: "Use the approved UI element term '%s' instead of '%s'"
+ignorecase: true
+level: error
+swap:
+  "navbar": "Main Menu"
+  "nav bar": "Main Menu"
+  "user dropdown": "User Menu"
+  "nested navbar": "<feature> Menu"
+  "nested nav bar": "<feature> Menu"
+  "three dots": "three-dot Menu"
+  "dropdown menu": "drop-down Menu"