From 38000f74af691ab05eae029121411e161c16441e Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Wed, 17 Jan 2024 11:41:40 -0800 Subject: [PATCH] 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 --------- Co-authored-by: Lenny Chen Co-authored-by: Karl Cardenas --- docs/docs-content/glossary-all.md | 2 +- vale/styles/spectrocloud/product-ui.yml | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 vale/styles/spectrocloud/product-ui.yml diff --git a/docs/docs-content/glossary-all.md b/docs/docs-content/glossary-all.md index 5de82ebb7c..68cbde57b1 100644 --- 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. \ No newline at end of file +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 new file mode 100644 index 0000000000..7715deca29 --- /dev/null +++ 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": " Menu" + "nested nav bar": " Menu" + "three dots": "three-dot Menu" + "dropdown menu": "drop-down Menu"