From 7061c5781fc4058409851ce431f1c23b18c490ca Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Thu, 16 Jan 2025 09:28:24 -0500 Subject: [PATCH 1/6] add vale rules for wording --- .../camunda/docsInstance/inclusiveLanguage.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 styles/camunda/docsInstance/inclusiveLanguage.yml diff --git a/styles/camunda/docsInstance/inclusiveLanguage.yml b/styles/camunda/docsInstance/inclusiveLanguage.yml new file mode 100644 index 00000000000..a03ca9cbe70 --- /dev/null +++ b/styles/camunda/docsInstance/inclusiveLanguage.yml @@ -0,0 +1,16 @@ +extends: existence +message: "Non-inclusive terminology used. Review the WCoE for using inclusive language." +level: warning +ignorecase: true +tokens: + - whitelist + - abort + - blackbox + - blacklist + - cripple + - he + - she + - master + - slave + - webmaster + - whitebox From ede74024b9540c1e1b84456a6648c984923f90ef Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Thu, 16 Jan 2025 09:47:17 -0500 Subject: [PATCH 2/6] add glossary terms --- styles/camunda/docsInstance/glossary.yml | 68 ++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 styles/camunda/docsInstance/glossary.yml diff --git a/styles/camunda/docsInstance/glossary.yml b/styles/camunda/docsInstance/glossary.yml new file mode 100644 index 00000000000..4c1d9b7338f --- /dev/null +++ b/styles/camunda/docsInstance/glossary.yml @@ -0,0 +1,68 @@ +extends: existence +message: "This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary." +level: warning +ignorecase: false +tokens: + - AirTable + - tomcat + - asana + - AzureAD + - back-pressure + - back pressure + - Camunda Cloud + - Chat GPT + - Configmap + - Config Map + - Docker compose + - Docker desktop + - Docker hub + - Easypost + - ElasticSearch + - Elastic search + - Element Template + - e-mail + - E-mail + - Event based process + - Github + - Gitlab + - Google drive + - Google maps + - Google sheets + - GRPC + - Heat map + - Helm Chart + - Hybrid Mode + - iFrame + - ingress + - Java Delegate + - Javascript + - jdk + - JIRA + - Job Worker + - Kafka Producer + - Kafka Consumer + - KeyCloak + - Linkedin + - MacOS + - Microsoft teams + - multitenancy + - multi tenancy + - Node.JS + - Opensearch + - Process Instance + - Rabbit MQ + - RedHat + - Rest API + - rest API + - Rest Api + - Run time + - Saas + - SalesForce + - Sendgrid + - Service Task + - Signup + - signup + - SpringBoot + - Whatsapp + - Whats App + - ZBCTL From 600319c8448a7cde4cbc00a4cb24b15e8cf87bf0 Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Thu, 16 Jan 2025 09:55:41 -0500 Subject: [PATCH 3/6] add whitelisted --- styles/camunda/docsInstance/inclusiveLanguage.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/styles/camunda/docsInstance/inclusiveLanguage.yml b/styles/camunda/docsInstance/inclusiveLanguage.yml index a03ca9cbe70..dd08da72174 100644 --- a/styles/camunda/docsInstance/inclusiveLanguage.yml +++ b/styles/camunda/docsInstance/inclusiveLanguage.yml @@ -4,6 +4,8 @@ level: warning ignorecase: true tokens: - whitelist + - white-listed + - white-list - abort - blackbox - blacklist From b73f65eb1241b511083e82d4435086c497dadea2 Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Thu, 16 Jan 2025 10:00:30 -0500 Subject: [PATCH 4/6] add british english styles --- styles/camunda/docsInstance/americanBritish.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 styles/camunda/docsInstance/americanBritish.yml diff --git a/styles/camunda/docsInstance/americanBritish.yml b/styles/camunda/docsInstance/americanBritish.yml new file mode 100644 index 00000000000..60fc9025fd3 --- /dev/null +++ b/styles/camunda/docsInstance/americanBritish.yml @@ -0,0 +1,10 @@ +extends: existence +message: "British English writing style detected. Use American spelling instead." +level: warning +ignorecase: true +tokens: + - organise + - analyse + - cancelled + - cancelling + - travelling From d3990bcaba7282e7a3cc49b90c7ee405eb618440 Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Fri, 17 Jan 2025 14:50:55 -0500 Subject: [PATCH 5/6] adjust to substitution and move to all folder --- styles/camunda/all/americanBritish.yml | 11 +++ styles/camunda/all/glossary.yml | 74 +++++++++++++++++++ styles/camunda/all/inclusiveLanguage.yml | 19 +++++ .../camunda/docsInstance/americanBritish.yml | 10 --- styles/camunda/docsInstance/glossary.yml | 68 ----------------- .../docsInstance/inclusiveLanguage.yml | 18 ----- 6 files changed, 104 insertions(+), 96 deletions(-) create mode 100644 styles/camunda/all/americanBritish.yml create mode 100644 styles/camunda/all/glossary.yml create mode 100644 styles/camunda/all/inclusiveLanguage.yml delete mode 100644 styles/camunda/docsInstance/americanBritish.yml delete mode 100644 styles/camunda/docsInstance/glossary.yml delete mode 100644 styles/camunda/docsInstance/inclusiveLanguage.yml diff --git a/styles/camunda/all/americanBritish.yml b/styles/camunda/all/americanBritish.yml new file mode 100644 index 00000000000..cdace7576a2 --- /dev/null +++ b/styles/camunda/all/americanBritish.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "British English writing style detected. Use American spelling instead." +level: error +ignorecase: true +swap: + organise: organize + analyse: analyze + cancelled: canceled + cancelling: canceling + travelling: traveling + travelled: traveled diff --git a/styles/camunda/all/glossary.yml b/styles/camunda/all/glossary.yml new file mode 100644 index 00000000000..d57106f811c --- /dev/null +++ b/styles/camunda/all/glossary.yml @@ -0,0 +1,74 @@ +extends: substitution +message: "This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary." +level: error +ignorecase: false +swap: + AirTable: Airtable + tomcat: Tomcat + asana: Asana + AzureAD: Azure AD + back-pressure: + back pressure: + Camunda Cloud: Camunda 8 + Chat GPT: ChatGPT + Configmap: ConfigMap + config map: ConfigMap + Config Map: ConfigMap + Docker compose: Docker Compose + Docker desktop: Docker Desktop + Docker hub: Docker Hub + Easypost: EasyPost + ElasticSearch: Elasticsearch + Elastic search: Elasticsearch + Element Template: Element template + e-mail: email + Event based process: Event-based process + event based process: event-based process + Github: GitHub + Gitlab: GitLab + Google drive: Google Drive + Google maps: Google Maps + Google sheets: Google Sheets + GRPC: gRPC + Heat map: Heatmap + heat map: heatmap + Helm Chart: Helm chart + Hybrid Mode: Hybrid mode + iFrame: iframe + ingress: Ingress + Java Delegate: + Javascript: JavaScript + jdk: JDK + JIRA: Jira + Job Worker: Job worker + Kafka Producer: Kafka producer + Kafka Consumer: Kafka consumer + KeyCloak: Keycloak + Linkedin: LinkedIn + MacOS: macOS + Microsoft teams: Microsoft Teams + multitenancy: multi-tenancy + multi tenancy: multi-tenancy + Multitenancy: Multi-tenancy + Multi tenancy: Multi-tenancy + Node.JS: Node.js + Opensearch: OpenSearch + Openshift: OpenShift + Process Instance: Process instance + Rabbit MQ: RabbitMQ + RedHat: Red Hat + Rest API: REST API + rest API: REST API + Rest Api: REST API + Run time: Runtime + run time: runtime + Saas: SaaS + SalesForce: Salesforce + Sendgrid: SendGrid + Service Task: Service task + Signup: Sign up + signup: sign up + SpringBoot: Spring Boot + Whatsapp: WhatsApp + Whats App: WhatsApp + ZBCTL: zbctl diff --git a/styles/camunda/all/inclusiveLanguage.yml b/styles/camunda/all/inclusiveLanguage.yml new file mode 100644 index 00000000000..a1a2913b53d --- /dev/null +++ b/styles/camunda/all/inclusiveLanguage.yml @@ -0,0 +1,19 @@ +extends: substitution +message: "Non-inclusive terminology used. Review the WCoE for using inclusive language." +level: error +ignorecase: true +swap: + whitelist: allowlist + white-listed: allow-listed + white-list: allow-list + abort: force quit + blackbox: closed box + blacklist: blocklist + cripple: slow down + cripples: slows down + he: they + she: they + master: main + slave: follower + webmaster: web manager + whitebox: open box diff --git a/styles/camunda/docsInstance/americanBritish.yml b/styles/camunda/docsInstance/americanBritish.yml deleted file mode 100644 index 60fc9025fd3..00000000000 --- a/styles/camunda/docsInstance/americanBritish.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "British English writing style detected. Use American spelling instead." -level: warning -ignorecase: true -tokens: - - organise - - analyse - - cancelled - - cancelling - - travelling diff --git a/styles/camunda/docsInstance/glossary.yml b/styles/camunda/docsInstance/glossary.yml deleted file mode 100644 index 4c1d9b7338f..00000000000 --- a/styles/camunda/docsInstance/glossary.yml +++ /dev/null @@ -1,68 +0,0 @@ -extends: existence -message: "This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary." -level: warning -ignorecase: false -tokens: - - AirTable - - tomcat - - asana - - AzureAD - - back-pressure - - back pressure - - Camunda Cloud - - Chat GPT - - Configmap - - Config Map - - Docker compose - - Docker desktop - - Docker hub - - Easypost - - ElasticSearch - - Elastic search - - Element Template - - e-mail - - E-mail - - Event based process - - Github - - Gitlab - - Google drive - - Google maps - - Google sheets - - GRPC - - Heat map - - Helm Chart - - Hybrid Mode - - iFrame - - ingress - - Java Delegate - - Javascript - - jdk - - JIRA - - Job Worker - - Kafka Producer - - Kafka Consumer - - KeyCloak - - Linkedin - - MacOS - - Microsoft teams - - multitenancy - - multi tenancy - - Node.JS - - Opensearch - - Process Instance - - Rabbit MQ - - RedHat - - Rest API - - rest API - - Rest Api - - Run time - - Saas - - SalesForce - - Sendgrid - - Service Task - - Signup - - signup - - SpringBoot - - Whatsapp - - Whats App - - ZBCTL diff --git a/styles/camunda/docsInstance/inclusiveLanguage.yml b/styles/camunda/docsInstance/inclusiveLanguage.yml deleted file mode 100644 index dd08da72174..00000000000 --- a/styles/camunda/docsInstance/inclusiveLanguage.yml +++ /dev/null @@ -1,18 +0,0 @@ -extends: existence -message: "Non-inclusive terminology used. Review the WCoE for using inclusive language." -level: warning -ignorecase: true -tokens: - - whitelist - - white-listed - - white-list - - abort - - blackbox - - blacklist - - cripple - - he - - she - - master - - slave - - webmaster - - whitebox From b3b158612bfbb11f0296f5b0740c1d072e095bd4 Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Wed, 22 Jan 2025 09:52:23 -0500 Subject: [PATCH 6/6] fill in backpressure --- styles/camunda/all/glossary.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/styles/camunda/all/glossary.yml b/styles/camunda/all/glossary.yml index d57106f811c..a455b72cea6 100644 --- a/styles/camunda/all/glossary.yml +++ b/styles/camunda/all/glossary.yml @@ -7,8 +7,8 @@ swap: tomcat: Tomcat asana: Asana AzureAD: Azure AD - back-pressure: - back pressure: + back-pressure: backpressure + back pressure: backpressure Camunda Cloud: Camunda 8 Chat GPT: ChatGPT Configmap: ConfigMap @@ -36,7 +36,7 @@ swap: Hybrid Mode: Hybrid mode iFrame: iframe ingress: Ingress - Java Delegate: + Java Delegate: Java delegate Javascript: JavaScript jdk: JDK JIRA: Jira