Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: add vale rules for wording #4861

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adjust to substitution and move to all folder
  • Loading branch information
christinaausley committed Jan 17, 2025
commit d3990bcaba7282e7a3cc49b90c7ee405eb618440
11 changes: 11 additions & 0 deletions styles/camunda/all/americanBritish.yml
Original file line number Diff line number Diff line change
@@ -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
74 changes: 74 additions & 0 deletions styles/camunda/all/glossary.yml
Original file line number Diff line number Diff line change
@@ -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:
christinaausley marked this conversation as resolved.
Show resolved Hide resolved
Camunda Cloud: Camunda 8
Chat GPT: ChatGPT
Configmap: ConfigMap
config map: ConfigMap
Config Map: ConfigMap
Docker compose: Docker Compose
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add "docker compose", as in the command (all lowercase)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or if that's written intentionally in code, as a terminal command, will this get flagged?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will get flagged -- similar to my lack of "javascript" currently. There are a few threads online discussing how we can ignore code blocks, but I may open this as a subsequent issue so I can do some research and testing on what that looks like?

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
19 changes: 19 additions & 0 deletions styles/camunda/all/inclusiveLanguage.yml
Original file line number Diff line number Diff line change
@@ -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
10 changes: 0 additions & 10 deletions styles/camunda/docsInstance/americanBritish.yml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these apply to the Optimize docs as well? Adding them to the styles/camunda/docsInstance folder means they'll only apply to the main docs instance.

I think you want to move them to the styles/camunda/all folder instead, so that they apply to both the main docs instance and the Optimize instance.

This file was deleted.

68 changes: 0 additions & 68 deletions styles/camunda/docsInstance/glossary.yml

This file was deleted.

18 changes: 0 additions & 18 deletions styles/camunda/docsInstance/inclusiveLanguage.yml

This file was deleted.