Skip to content

Fix documentation copy typos#156

Merged
hauptmedia merged 41 commits into
mainfrom
codex/docs-copy-edits
Jun 18, 2026
Merged

Fix documentation copy typos#156
hauptmedia merged 41 commits into
mainfrom
codex/docs-copy-edits

Conversation

@hauptmedia

@hauptmedia hauptmedia commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • fix copy typos, duplicated words, grammar issues, and terminology casing across reference, user-guide, webapp, installation, and archived tutorial docs
  • normalize product and technology spelling such as REST API, JavaScript, WildFly, WebSphere, WebLogic, Maven, Logback, Spring Boot, web application, behavior, cancellation, and time zone wording in edited passages
  • polish CMMN lifecycle/task/sentry wording, embedded-form lifecycle and Java object terminology, process-engine prose, Cockpit/Tasklist/Admin copy, Spring/CDI/Quarkus wording, and visible BPMN example labels without changing behavior
  • polish Cockpit dashboard, task dashboard, CMMN/DMN dashboard, CMMN/DMN view, BPMN detail view, batch-operation, and deployment-view UI wording around search controls, selection/export wording, view navigation, deployment actions, incidents/jobs, message correlation, and batch-operation review/results copy
  • polish Admin authorization, user, group, tenant, and system-management wording around permissions, diagnostics, metrics, profile navigation, and membership actions
  • correct Connect, Spin, and DMN custom-extension/decision-table wording around class names, data formats, service-loader lookup, XML namespace examples, extension namespaces, file-reading examples, and keep the legacy Spin custom-dataformats anchor stable after the heading cleanup
  • clean up get-started project setup titles, WildFly LDAP setup wording, process-archive resource wording, and LDAP authorization/identity-service copy
  • polish Spring Boot webapp quickstart, integration, security, and event-bridge wording, including BOM wording, JAR-file wording, embedded Tomcat/webapp resource copy, CSRF-token casing, listener-skipping copy, and web app terminology
  • polish OAuth logout, message-event, deployment-cache, runtime-container, Tasklist dashboard/accessibility, Welcome, Admin authorization, and Spring Boot quickstart wording
  • polish shared webapp security option wording for CSRF, cookie, and HTTP header settings, including a copied Content-Type option reference
  • remove obsolete Optimize product references from the process-engine descriptor and authorization docs, keeping documented application permissions aligned with Admin, Cockpit, and Tasklist
  • keep this PR limited to copy, terminology, and open-source product-alignment edits without changing download guidance, snapshot documentation, or external-link policy

Verification

  • git diff --check
  • focused rg checks for the corrected typo and terminology patterns in the edited files return no matches
  • rg -n '\bOptimize\b|`optimize`' docs -g '*.md' -g '*.mdx' -S returns no matches
  • rg -n 'http://camunda\.com|camunda\.com|Camunda' docs/documentation/reference/spin/xml/04-querying-xml.md docs/documentation/reference/spin -S returns no matches
  • rg -n -i 'camunda namespace|`camunda` namespace|camunda prefix|camunda extension' docs/documentation/reference/dmn/custom-extensions/operaton-attributes.md -S returns no matches
  • rg -n 'xmlns:operaton="http://operaton\.org/schema/1\.0/dmn`|xmlns:operaton="http://operaton\.org/schema/1\.0/dmn"' docs/documentation/reference/dmn/decision-table/input.md -S confirms the inline namespace snippet is quoted consistently with the XML block
  • rg -n "does all the magic|Starter for Webapps|JAR-file|autoconfiguration|Operaton Engine needs|application opening|Operaton webapps|already occupied|CSRF Token|session will be ended|Filter Whitelist|coming with the Spring Boot|put them to|Webapps under" docs/get-started/spring-boot/project-setup.md docs/documentation/user-guide/spring-boot-integration/webapps.md -S returns no matches
  • rg -n -i "\b(listner|listners|hooked-up|by a engine|skip listners|latter of those|creating of the user task|allows us to|The eventing is controlled)\b|\s+$" docs/documentation/user-guide/spring-boot-integration/the-spring-event-bridge.md -S returns no matches
  • rg -n -i "\b(hit|simply|possibility|out of the displayed|click on \*|clicking on|drop down|Process-, Task- and Case Variables|case sensitive|case insensitive|specified criteria|Task can|User Task description|username and inserting|Underneath|upper right side|instantly set full focus|Variables mentioned above)\b" docs/documentation/webapps/tasklist/dashboard.md -S returns no matches
  • rg -n -i '\b(cockpit Search|clicking on|click on|drop down|hover over the deployment |specified criteria|non-existing|respective row|Operations Engineer|batch operation on|clicking "Batch operation"|which fulfill|operators other than equal|crunches|checkmark|single resources|therefore overwrite|resources which|respective definition|Definition Of operation|Jobs belonging|Removal Time to Historic|Correlate Message|One can see|is able to)\b' docs/documentation/webapps/cockpit/bpmn/dashboard.md docs/documentation/webapps/cockpit/batch/batch-operation.md docs/documentation/webapps/cockpit/deployment-view.md -S returns no matches
  • rg -n -i '\b(clicking on|click on|drop down|possibility|which fulfill|operators other than equal|CMMN Cases dashboard of Cockpit|decisions dashboard of Cockpit|dashboard of Cockpit|right hand side|amount of running|specified range of time|respective search|provides you with a list|provides you an overview|Deployed Decision Requirements Definition$)\b' docs/documentation/webapps/cockpit/dashboard.md docs/documentation/webapps/cockpit/tasks-dashboard.md docs/documentation/webapps/cockpit/cmmn/dashboard.md docs/documentation/webapps/cockpit/dmn/dashboard.md -S returns no matches
  • rg -n -i '\b(clicking on|click on|drop down|respective|which fulfill|operators other than equal|definition requirements definition|decision requirement definition|By clicking on|dropdown menu|provides you with information|will take you|will open|listing of all|allows you to|Hit the|formated|documentations|duedate|suit the search query|respectively the|on diagram|multiple decision definition|Objects, Files and Bytes)\b' docs/documentation/webapps/cockpit/cmmn/case-definition-view.md docs/documentation/webapps/cockpit/cmmn/case-instance-view.md docs/documentation/webapps/cockpit/dmn/decision-definition-view.md docs/documentation/webapps/cockpit/dmn/decision-instance-view.md docs/documentation/webapps/cockpit/dmn/decision-requirements-definition-view.md docs/documentation/webapps/cockpit/dmn/decision-requirements-instance-view.md -S returns no matches
  • rg -n -i '\b(clicking on|click on|drop down|respective|which fulfill|which are displayed|which is displayed|will take you|will open|will show|will be sent|will increment|allows you to|allows to|Hit the|hitting|duedate|dialogue|stacktrace|sub process|hirarchy|an summary|suit the search query|respectively the|Beside the diagram view|single or multiple|amount of retries|External Task Id|Worker Id|flow-node)\b' docs/documentation/webapps/cockpit/bpmn/process-instance-view.md docs/documentation/webapps/cockpit/bpmn/process-instance-restart.md docs/documentation/webapps/cockpit/bpmn/failed-jobs.md docs/documentation/webapps/cockpit/bpmn/drilldown.md docs/documentation/webapps/cockpit/bpmn/correlate-message.md -S returns no matches
  • rg -n -i '\b(Besides that|an user|users account|click on|which are|which is|users which|granted with|allows you to|Flow Nodes Instances|Underneath)\b|\s+$' docs/documentation/webapps/admin/tenant-management.md docs/documentation/webapps/admin/group-management.md docs/documentation/webapps/admin/system-management.md -S returns no matches
  • rg -n "contentSecurityPolicyValue|contentSecurityPolicyDisabled|contentTypeOptionsValue|contentTypeOptionsDisabled" docs/documentation/webapps/shared-options/header-security.md -S confirms the option notes reference the matching disable flags
  • rg -n "custom-dataformats" docs/documentation/reference/spin/extending-spin.md docs/documentation/user-guide/data-formats/data-formats-in-processes.md docs/documentation/user-guide/spring-boot-integration/configuration.mdx -S confirms the old links still have a matching heading anchor
  • gh pr view 156 --json files --jq .files[].path | xargs rg -n "\\s+$" -S returns no matches
  • npm run typecheck
  • npm run build succeeds; Docusaurus still reports the known pre-existing broken link/anchor warnings handled separately in Fix docs link checks and enforce quality gates #115

@hauptmedia hauptmedia merged commit 3eed49c into main Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant