docs(operate): Add Operate API access (#649)

* docs(operate): add Operate API access - fix table format Related with #616 * Update configuration.md technical documentation review * style(formatting): technical review of existing Concepts documentation (#572) * style(formatting): technical review of existing Concepts documentation * resolving broken links * style(formatting): technical overview of Modeler Components docs (#584) * style(formatting): technical overview of Modeler documentation among Components * resolving broken links * Removing deprecated references (#600) Removing references to zeebe-docker-compose because it is depricated * Added variable propagation in xml (#601) * Fix typo (#603) I think this meant to say 'unary test' * Update public-api.md (#595) * Update public-api.md Corrected spelling error in word comptability * Update public-api.md Rephrasing sentence for clarity. Co-authored-by: christinaausley <[email protected]> * Document Zeebe Cold Backups (#581) * Document Zeebe Cold Backups * Refer to the backup documentation * Include 1.3 in the update guide overview * Review of the cold backup documentation * Adjust wording of warning about filesystem links Co-authored-by: Nicolas Pepin-Perreault <[email protected]> * Use more forceful wording for backup guide * Update backups.md technical review with minor comments * Review of the cold backup documentation * add motivation for taking backups * explain why clients need to be considered during downtime * don't use caution admonition to stay consistent with color guidelines Co-authored-by: Nicolas Pepin-Perreault <[email protected]> Co-authored-by: christinaausley <[email protected]> * Modified script-task Docu (#604) * Modified script-task docu Fixed variable mapping link & added zeebe script worker community extension. * Variable-mappings links to service task * Linked variable mappings (#605) and added a minor sentence * Updated the variable mappings in send & receive tasks/events (#602) * Updated the variable mappings in send & receive tasks/events * fix broken link * fixed typo * Resolved PR Comments * docs(operate): Update note for critical issue fixed on 1.3.4 (#623) * docs(usage-metrics): Updating usage metrics docs to have sample response (#617) * docs(usage-metrics): Updating usage metrics docs to have sample response * Update usage-metrics.md Technical review. Co-authored-by: christinaausley <[email protected]> * Check product links on build and link check (#632) * chore: add product links to build docs check * chore: make trailing slash optional for duplicate path redirect * chore: add product links to nightly link checker * chore: fix linkcheck file name * chore: checkout repo in link check workflow * chore: remove invalid http scheme from github action * style(formatting): technical review of APIs and Clients documentation (#627) * Adding best practices (#631) * Adding possibility to render BPMN diagrams with callouts * removed comments * Added "Naming BPMN Elements" * Added "Building Flexibility Into BPMN Models" * Improved BPMN integration and callouts * Added "Creating Readable Process Models" * Improved BPMN integration and callouts * trying to improve callouts * Added "Modeling beyond the happy path" * Initial check-in of "Choosing the DMN hit policy" * added first draft of sizing best practice (missing disk space) * Added C7 sizing BP * weakened benchmark project * switching to lower case headlines * renamed "-bpmn" / "-dmn" to "-assets" folder * Added thumbs-down for BPMN models * added modeling-with-situation-patterns * fixed CSS merge * Added handling-data-in-processes * fixed link * migrated invoking-services-from-the-process as C7 specific BP * migrated connecting-the-workflow-engine-with-your-world from blog post * Iterated over sizing best practice with the latest learnings * Fixed numbers, adjusted to latest learnings * typo * Migrated service-integration-patterns from blog * migrated writing-good-workers * removed outdated CC version warning * converted routing-events-to-processes * Initial convertion of dealing-with-exception, branching out C7-only content * typos * Drafted initial version of dealing-with-exceptions * migrated deciding-about-your-stack-c7 * migrated doing-a-proper-poc * copy edit of creating readable process models and modeling beyond the happy path * adjusted C7 stack and added new community extension * looked through copy edit * technical review of Modeling with Situation Patterns and Naming BPMN Elements * Adjusted to use trailing slashes (bpmn viewer now can handle both) * Fixed usage of trailing slashes * fixing links * fixing links * initial convertion (still needing serious work) * Fixed trailing slash detection in bpmn.js thingy * converted naming-technically-relevant-ids * style(formatting): technical review of building flexibility and choosing hit policy * Converted performance-tuning-camunda-c7 * Added sidebar and overview * Small fixed to prep for copy edit * Small fixed to prep for copy edit * migrated securing C7 * linked to the docs for security * converted operating-camunda-c7 * style(formatting): review of deciding about stack, poc, and naming relevant ids * typo * converted versioning-process-definitions * Converted reporting-about-processes-assets/ * Converted reporting-about-processes-assets/ * Converted reporting-about-processes-assets/ * migrated following-the-customer-success-path integrating estimating-effort * intermediate step for testing * slightly restructured BP content * first draft of new testing bp * Improved testing-process-definitions * style(formatting): technical review of sizing your environment and following the customer success path * converted human task related practices * Fixed problem with BPMN's not getting rendered on page changes (moved initialization to plugin) * fixed broken links * Fixed links * fixed links * fixed links * moved svg images to static assets * fixed links * fixed linked image * Fixed double visualization of bpmns * commented polyglot tests for now * slightly improved C7 wording * added greenfield stack BP for CC * typo * fixed link * adjusted package-lock.json to master version, added missing bp to sidebar * Converted https://camunda.com/best-practices/understanding-process-migration/ * fixed links after fetching upstream changes * Fixed overview and headlines * Fixed DMN file loading (trailing slashes) * adjusted to latest numbers * docs(usage-metrics): Updating usage metrics docs to have sample response (#617) * docs(usage-metrics): Updating usage metrics docs to have sample response * Update usage-metrics.md Technical review. Co-authored-by: christinaausley <[email protected]> * chore: fix broken internal links * chore: add redirect for best-practices overview page * Moved BPMN models to static/ to make docusaurus happy * docs(best practices): remove extra frontmatter values * Added calculcation exportet from GDocs * docs(best-practices): remove .vscode file Co-authored-by: Bernd Ruecker <[email protected]> Co-authored-by: Bernd Ruecker <[email protected]> Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: Luiz Santana <[email protected]> Co-authored-by: christinaausley <[email protected]> Co-authored-by: Amara <[email protected]> * style(formatting): technical overview of Zeebe Components docs (#586) * style(formatting): technical overview of Zeebe Components docs * resolving broken link anchor text * resolving broken links * pressed commit too quickly, actually resolving broken links * Update overview.md removing comment * resolving broken link * style(formatting): technical overview of Tasklist Components docs (#594) * style(formatting): technical overview of Tasklist Components docs * added comment * adding dictionary extension notes to gitignore * Merge branch 'master' into technicalreview-tasklist * implementing redirect for faq * style(formatting): technical review of existing Cloud Console docs (#580) * style(formatting): technical review of existing Cloud Console documentation * resolving comments * Update create-cluster-include.md Removing comment. * feat(variable-labeling): Update the documentation so that conflicting… (#624) feat(variable-labeling): Update the documentation so that conflicting variable labeling behaviour is underlined relates to: OPT-5966 * fix(bpmn-js): Load process models in right format * fix(dmn-js): Load DMN models in right format * Unified the variable-mapping description (#615) * Unified the variable-mapping description - business-rule-task - script-tasks - send-tasks * Fixes #1 * Fixex #2 * Technicalreview optimize (#628) * style(formatting): technical review of Optimize documentation * editorial adjustments * adjustinng link reference * incorporating Optimize into the development process (#619) * incorporating Optimize into the development process * adding note on multiprocess templates * adding alerts feature * resolving final comments * fix (best-practices) Adjusted partition count to latest G3-S config * fix(migration guide): Softened language around migration * 609 supporting helm charts (#614) * Updated installation guide for ccsm helm charts - removed old picture and added new one - removed old kind-values.yaml - updated the docu and its structure * Reworking page structure - No "Helm" subfolder - Combined 2x Overviews and Prerequisites - Renamed "Accessing Operate..." to "Accessing Operate and Tasklist..." * Update guide for "Accessing Operate and Tasklist" - Added new pictures for login and dashboard - Removed old pictures - Updated guide and moved network docu * Removed unused assets * style(formatting): technical documentation review * implementing redirects * typo in redirects * resolving links * docs(redirects): small fix * docs(kubernetes): link fix for build errors * Update docs/self-managed/zeebe-deployment/kubernetes/helm/installing-helm.md Co-authored-by: Christopher Zell <[email protected]> * chore: fix redirects for helm * Content overhaul #1 Resolving Zelldon's comments * Content overhaul #2 * Update docs/self-managed/zeebe-deployment/kubernetes/index.md Co-authored-by: Christopher Zell <[email protected]> * Content overhaul #3 Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: Amara <[email protected]> Co-authored-by: Christopher Zell <[email protected]> Co-authored-by: Sebastian Menski <[email protected]> * FIrst documentation for Web Modeler (#620) * docs(web-modeler): rough first update * docs(web-modeler): rename Cloud Modeler to Web Modeler and Camunda Modeler to Desktop Modeler * docs(web-modeler): rewrite launch-cloud-modeler.md page * docs(web-modeler): fix issues that ocurred after rebase * docs(web-modeler): rewrite model-your-first-diagram.md page * docs(web-modeler): rewrite import-diagram.md page * docs(web-modeler): rewrite save-and-deploy.md page * docs(web-modeler): rewrite start-instance.md page * docs(web-modeler): remove model-overview.md page * docs(web-modeler): document project roles and invitation * docs(web-modeler): finish docs for collaboration: folder, share, embed, comment, mention * docs(web-modeler): document milestones and diffing * docs(web-modeler): rewrite utilizing-forms.md page and use updated imgs * docs(web-modeler): rewrite automating-a-process-using-bpmn.md and use updated imgs * docs(web-modeler): rewrite getting-started-orchestrate-microservices.md and use updated imgs * docs(web-modeler): rewrite model-your-first-process.md and use updated imgs * docs(web-modeler): rewrite deploy-your-process-and-start-process-instance.md and use updated imgs * docs(web-modeler): rewrite implement-service-task.md and use updated imgs * docs(web-modeler): update implement-decision-gateway.md page and use updated imgs * docs(web-modeler): add supported browsers and cleanup unused images * docs(web-modeler): add news about web modeler and migration * docs(web-modeler): document canvas tools, real time collaboration and attention grabber * docs(redirects): support modeler rename * docs(redirects): add redirect for cloud modeler overview * docs(redirects): swap order * docs(web-modeler): add bpmn guide to next steps * docs(modeler): link to modeler about in bpmn-primer page * style(formatting): technical review of documentation * merge conflict with rename * docs(web-modeler): resolve review comments Co-authored-by: Amara <[email protected]> Co-authored-by: Christina Ausley <[email protected]> * Typo (#642) * link typo * chore(desktopModeler): update screenshots (#651) * docs(guides): removing retired whitepaper link Marketing retired the "How to migrate to Camunda" whitepaper so this information is no longer available. * Update badges (#656) * update badges, introduce Cloud only badge * update colors, rename Platform Badge * docs(self-managed): update overview note * style(formatting): technical overview of Operate Components docs (#593) * style(formatting): technical overview of Zeebe Components docs * resolving comments * resolving lingering comments in documentation (#657) * Updates guides for Modeler (#658) * docs(guides): update MO guide for modeler updates * typo on keywords * docs(guides): guide updates including links, keywords Co-authored-by: christinaausley <[email protected]> Co-authored-by: Thomas Heinrichs <[email protected]> Co-authored-by: Falko Menge <[email protected]> Co-authored-by: GmGamez <[email protected]> Co-authored-by: Ole Schönburg <[email protected]> Co-authored-by: Nicolas Pepin-Perreault <[email protected]> Co-authored-by: Luiz Santana <[email protected]> Co-authored-by: Sebastian Menski <[email protected]> Co-authored-by: Bernd Ruecker <[email protected]> Co-authored-by: Bernd Ruecker <[email protected]> Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: Amara <[email protected]> Co-authored-by: Andromachi Rozaki <[email protected]> Co-authored-by: Christopher Zell <[email protected]> Co-authored-by: Catalina Moisuc <[email protected]> Co-authored-by: Ragnar Nevries <[email protected]> Co-authored-by: Amara Graham <[email protected]> Co-authored-by: MaxTru <[email protected]>
camunda · Mar 2, 2022 · d7186b6 · d7186b6
1 parent e86f274
commit d7186b6
Show file tree

Hide file tree

Showing 583 changed files with 35,150 additions and 1,587 deletions.
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
@@ -29,6 +29,8 @@ jobs:
           echo "container_ip=$(docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' webserver)" >> $GITHUB_ENV
       - name: Download sitemap from production
         run: curl -sL https://docs.camunda.io/sitemap.xml | grep -oP '<loc>\K.*?(?=</loc>)' | sed "s!https://docs.camunda.io!http://${{ env.container_ip }}:8080!g" > sitemap.prod.txt
+      - name: Prepare product links
+        run:  grep 'https://docs.camunda.io' product-links.txt | sed "s!https://docs.camunda.io!http://${{ env.container_ip }}:8080!g" > product-links.prod.txt
       - name: Waiting for URL available
         uses: nev7n/wait_for_response@v1
         with:
@@ -40,4 +42,7 @@ jobs:
         #  arguments: '-i sitemap.prod.txt'
         run: |
           curl -sL https://github.com/filiph/linkcheck/releases/download/2.0.20/linkcheck-2.0.20-linux-x64.tar.gz | tar xvzf - linkcheck/linkcheck --strip 1
+          # Check links from production sitemap to ensure no publish links are broken
           ./linkcheck -i sitemap.prod.txt
+          # Check links from other products to ensure no links are broken
+          ./linkcheck -i product-links.prod.txt
diff --git a/.github/workflows/linkcheck.yaml b/.github/workflows/linkcheck.yaml
@@ -13,13 +13,19 @@ jobs:
       matrix:
         url: [ "https://docs.camunda.io", "https://stage.docs.camunda.io" ]
     steps:
+      - uses: actions/checkout@v2
       - name: Download sitemap from production
-        run: curl -sL https://docs.camunda.io/sitemap.xml | grep -oP '<loc>\K.*?(?=</loc>)' | sed "s!https://docs.camunda.io!${{ matrix.url }}!g" > sitemap.txt
+        run: curl -sL https://docs.camunda.io/sitemap.xml | grep -oP '<loc>\K.*?(?=</loc>)' | sed "s!https://docs.camunda.io!${{ matrix.url }}!g" > sitemap.prod.txt
+      - name: Prepare product links
+        run:  grep 'https://docs.camunda.io' product-links.txt | sed "s!https://docs.camunda.io!${{ matrix.url }}!g" > product-links.prod.txt
         # disable action until https://github.com/tylerbutler/linkcheck-bin/issues/1 is released
         #uses: filiph/[email protected]
         #with:
         #  arguments: '-i sitemap.prod.txt'
       - name: Check internal links from sitemap
         run: |
           curl -sL https://github.com/filiph/linkcheck/releases/download/2.0.20/linkcheck-2.0.20-linux-x64.tar.gz | tar xvzf - linkcheck/linkcheck --strip 1
-          ./linkcheck -i sitemap.txt
+          # Check links from production sitemap to ensure no publish links are broken
+          ./linkcheck -i sitemap.prod.txt
+          # Check links from other products to ensure no links are broken
+          ./linkcheck -i product-links.prod.txt
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+.vscode/*
 
 # Misc
 .DS_Store
@@ -20,3 +21,4 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 node_modules
+/camunda-cloud-documentation.iml
diff --git a/.vscode/ltex.dictionary.en-US.txt b/.vscode/ltex.dictionary.en-US.txt
@@ -0,0 +1,2 @@
+Zeebe
+Tasklist
diff --git a/docs/apis-clients/build-your-own-client.md b/docs/apis-clients/build-your-own-client.md
@@ -62,7 +62,7 @@ For gRPC handling, complete the following steps:
 npm install -g grpcurl-tools
 ```
 
-3. Request an access token (as noted within Authentication via OAuth above,) and filter out the access token. Write the value for follow-up processing into a variable:
+3. Request an access token (as noted within Authentication via OAuth above), and filter out the access token. Write the value for follow-up processing into a variable:
 
 ```bash
 export ACCESS_TOKEN=$(curl -s --request POST \

diff --git a/docs/apis-clients/cli-client/get-started.md b/docs/apis-clients/cli-client/get-started.md
@@ -18,7 +18,7 @@ In this tutorial, you will learn to use the CLI client `zbctl` to interact with
 
 ### Installation
 
-An installation can be done quickly via the package manager `npm`. The corresponding package is [here](https://www.npmjs.com/package/zbctl).
+Quickly install via the package manager `npm`. The corresponding package is [here](https://www.npmjs.com/package/zbctl).
 
 ```bash
 npm i -g zbctl

diff --git a/docs/apis-clients/cli-client/index.md b/docs/apis-clients/cli-client/index.md
@@ -8,7 +8,7 @@ sidebar_label: "Quick reference"
 
 ## Installation
 
-An installation can be done quickly via the package manager `npm`. The corresponding package is [here](https://www.npmjs.com/package/zbctl).
+Quickly install via the package manager `npm`. The corresponding package is [here](https://www.npmjs.com/package/zbctl).
 
 ```bash
 npm i -g zbctl

diff --git a/docs/apis-clients/cloud-console-api-reference.md b/docs/apis-clients/cloud-console-api-reference.md
@@ -1,6 +1,7 @@
 ---
 id: cloud-console-api-reference
 title: Cloud Console API clients (REST)
+description: "To interact with Camunda Cloud programmatically without using the Camunda Cloud UI, create Cloud API clients."
 ---
 
 ## Cloud API management
@@ -35,9 +36,7 @@ curl --header "Content-Type: application/json" \
 Access tokens have a validity period found in the access token. After this time, a new access token must be requested.
 :::
 
-:::note
-The auth service has built-in rate limiting. If too many token requests are executed in a short time, the client is blocked for a certain time. Since the access tokens have a certain validity period, they must be cached on the client side.
-:::
+Note that the auth service has built-in rate limiting. If too many token requests are executed in a short time, the client is blocked for a certain time. Since the access tokens have a certain validity period, they must be cached on the client side.
 
 ## Console API (REST)
 

diff --git a/docs/apis-clients/community-clients/index.md b/docs/apis-clients/community-clients/index.md
@@ -10,4 +10,4 @@ In addition to the core Java and Go clients provided by Zeebe, there are a numbe
 - [Python](python.md)
 - [Ruby](ruby.md)
 - [Rust](rust.md)
-- [Spring](spring.md)
+- [Spring](spring.md)
diff --git a/docs/apis-clients/community-clients/rust.md b/docs/apis-clients/community-clients/rust.md
@@ -4,7 +4,7 @@ title: "Rust"
 description: "Take a deeper look at the source code, Rust crate, and a podcast interview alongside Rust."
 ---
 
-The Rust client, Zeebest, was previously maintained by [Mackenzie Clark](https://github.com/xmclark), and is currently seeking a new Maintainer!
+The Rust client, Zeebest, was previously maintained by [Mackenzie Clark](https://github.com/xmclark), and is currently seeking a new maintainer!
 
 * [Source code](https://github.com/camunda-community-hub/zeebest)
 * [Rust crate](https://docs.rs/zeebest/0.20.0/zeebest/)

diff --git a/docs/apis-clients/go-client/get-started.md b/docs/apis-clients/go-client/get-started.md
@@ -182,8 +182,6 @@ Run the program and verify the process instance is created. You should see an ou
 processKey:2251799813686742 bpmnProcessId:"order-process" version:3 processInstanceKey:2251799813686744
 ```
 
-You did it!
-
 ## See the process in action
 
 Want to see how the process instance is executed? Follow the steps below:
@@ -358,9 +356,5 @@ processKey:2251799813686750 bpmnProcessId:"order-process" version:4 processInsta
 
 ## What's next?
 
-Yay! You finished this tutorial and learned the basic usage of the Go client.
-
-Next steps:
-
 - Learn more about the [concepts behind Zeebe](/components/concepts/what-is-camunda-cloud.md).
 - Learn more about [BPMN processes](/components/modeler/bpmn/bpmn-primer.md).
diff --git a/docs/apis-clients/grpc.md b/docs/apis-clients/grpc.md
@@ -1,6 +1,7 @@
 ---
 id: grpc
 title: "Zeebe API (gRPC)"
+description: "Zeebe clients use gRPC to communicate with the cluster."
 ---
 
 [Zeebe](../components/zeebe/zeebe-overview.md) clients use [gRPC](https://grpc.io/) to communicate with the cluster.
@@ -11,7 +12,7 @@ This specification still contains references to YAML workflows. This is a [depre
 
 ## Gateway service
 
-The Zeebe Client gRPC API is exposed through a single gateway service.
+The Zeebe client gRPC API is exposed through a single gateway service.
 
 ### `ActivateJobs` RPC
 
@@ -89,9 +90,9 @@ message ActivatedJob {
 
 Returned if:
 
-- type is blank (empty string, null)
-- worker is blank (empty string, null)
-- timeout less than 1 (ms)
+- Type is blank (empty string, null)
+- Worker is blank (empty string, null)
+- Timeout less than 1 (ms)
 - maxJobsToActivate is less than 1
 
 ### `CancelProcessInstance` RPC
@@ -650,7 +651,7 @@ Returned if:
 
 In the documentation above, the documented errors are business logic errors.
 These errors are a result of request processing logic, and not serialization, network, or
-other more general errors. These error are described in this sections.
+other more general errors. These errors are described in this section.
 
 The gRPC API for Zeebe is exposed through an API gateway, which acts as a proxy
 for the cluster. Generally, this means the clients execute a remote call on the gateway,
@@ -662,7 +663,7 @@ the broker is unavailable, etc.) are reported to the client using the following
 
 - `GRPC_STATUS_RESOURCE_EXHAUSTED`: When a broker receives more requests than it can handle, it signals back-pressure and rejects requests with this error code.
   - In this case, it is possible to retry the requests with an appropriate retry strategy.
-  - If you receive many such errors within a small time period, it indicates the broker is constantly under high load.
+  - If you receive many such errors within a short time period, it indicates the broker is constantly under high load.
   - It is recommended to reduce the rate of requests.
     When back-pressure is active, the broker may reject any request except _CompleteJob_ RPC and _FailJob_ RPC.
   - These requests are white-listed for back-pressure and are always accepted by the broker even if it is receiving requests above its limits.

diff --git a/docs/apis-clients/java-client-examples/cluster-topology-request.md b/docs/apis-clients/java-client-examples/cluster-topology-request.md
@@ -7,11 +7,11 @@ This example shows which broker is leader and follower for which partition. This
 
 ## Related resources
 
-- [Clustering casics](/components/zeebe/technical-concepts/clustering.md)
+- [Clustering basics](/components/zeebe/technical-concepts/clustering.md)
 
 ## Prerequisites
 
-1. Running Zeebe broker with endpoint `localhost:26500` (default)
+Run Zeebe broker with endpoint `localhost:26500` (default).
 
 ## TopologyViewer.java
 

diff --git a/docs/apis-clients/java-client-examples/data-pojo.md b/docs/apis-clients/java-client-examples/data-pojo.md
@@ -11,7 +11,7 @@ description: "Let's analyze the prerequisites and code to handle variables as PO
 ## Prerequisites
 
 1. Run the Zeebe broker with endpoint `localhost:26500` (default).
-1. Run the [deploy a process example](process-deploy.md).
+2. Run the [deploy a process example](process-deploy.md).
 
 ## HandleVariablesAsPojo.java
 

diff --git a/docs/apis-clients/java-client-examples/index.md b/docs/apis-clients/java-client-examples/index.md
@@ -4,7 +4,7 @@ title: "Java examples"
 sidebar_label: "Overview"
 ---
 
-Let's analyse a few examples utilizing Java to deploy a process, open a job worker, handle variables, and request cluster topology.
+Let's analyze a few examples utilizing Java to deploy a process, open a job worker, handle variables, and request cluster topology.
 
 These examples are accessible in the [Zeebe GitHub repository](https://github.com/camunda-cloud/zeebe/) on the [develop branch](https://github.com/camunda-cloud/zeebe/tree/develop/samples).
 

diff --git a/docs/apis-clients/java-client-examples/process-deploy.md b/docs/apis-clients/java-client-examples/process-deploy.md
@@ -11,7 +11,7 @@ description: "Let's analyze the prerequisites and code to deploy a process using
 
 ## Prerequisites
 
-1. Run the Zeebe broker with endpoint `localhost:26500` (default).
+Run the Zeebe broker with endpoint `localhost:26500` (default).
 
 ## ProcessDeployer.java
 
@@ -29,7 +29,7 @@ final DeploymentEvent deploymentEvent =
 
 [Source on GitHub](https://github.com/camunda-cloud/zeebe/tree/develop/samples/src/main/resources/demoProcess.bpmn)
 
-Download the XML and save it in the Java classpath before running the example. Open the file with Camunda Modeler for a graphical representation.
+Download the XML and save it in the Java classpath before running the example. Open the file with Desktop Modeler for a graphical representation.
 
 <!--
 ```xml

diff --git a/docs/apis-clients/java-client-examples/process-instance-create-nonblocking.md b/docs/apis-clients/java-client-examples/process-instance-create-nonblocking.md
@@ -7,7 +7,7 @@ description: "Let's analyze the prerequisites and code to create non-blocking pr
 ## Prerequisites
 
 1. Run the Zeebe broker with endpoint `localhost:26500` (default).
-1. Run the [deploy a process example](process-deploy.md).
+2. Run the [deploy a process example](process-deploy.md).
 
 ## NonBlockingProcessInstanceCreator.java
 

diff --git a/docs/apis-clients/java-client/index.md b/docs/apis-clients/java-client/index.md
@@ -25,7 +25,7 @@ implementation 'io.camunda:zeebe-client-java:${zeebe.version}'
 
 Use the latest released version from [Maven Central](https://search.maven.org/artifact/io.camunda/zeebe-client-java).
 
-## Spring Integration
+## Spring integration
 
 If you build a Spring or Spring Boot application, you might want to use [Spring Zeebe](/apis-clients/community-clients/spring.md) instead of handling the lifecycle and configuration of the Java client yourself (as described in the following paragraphs).
 
@@ -90,9 +90,6 @@ ZeebeClient client =
 ## Next steps
 
 - [Getting Started Guide](https://github.com/camunda-cloud/camunda-cloud-get-started): A comprehensive tutorial that covers Camunda Modeler, Operate, and the Java client.
-
-[//]:# (Should we link to the desktop browser version of the gettin started guide here?)
-
 - [Job worker](job-worker.md): An introduction to the Java client's job worker.
 - [Logging](logging.md): An introduction to configuring logging for a Zeebe client.
 - [Writing tests](testing.md): An introduction to writing tests that use an embedded version of the workflow engine.

diff --git a/docs/apis-clients/java-client/logging.md b/docs/apis-clients/java-client/logging.md
@@ -4,7 +4,7 @@ title: "Logging"
 description: "Here, we'll take a look at logging details in the case a job handler fails execution."
 ---
 
-The client uses SLF4J for logging useful notes, such as exception stack traces when a job handler fails execution. Using the SLF4J API, any SLF4J implementation can be plugged in. The following example uses Log4J 2.
+The client uses SLF4J for logging useful notes, such as exception stack traces when a job handler fails execution. Using the SLF4J API, any SLF4J implementation can be plugged in. The following example uses Log4J 2:
 
 ## Maven dependencies
 

diff --git a/docs/apis-clients/java-client/testing.md b/docs/apis-clients/java-client/testing.md
@@ -1,7 +1,9 @@
 ---
 id: testing
 title: "Writing tests"
+description: "Use the zeebe-test module to write JUnit tests for your job worker and BPMN process."
 ---
+
 You can use the `zeebe-test` module to write JUnit tests for your job worker and BPMN process. This provides a JUnit rule to bootstrap the broker and some basic assertions.
 
 :::note
@@ -70,4 +72,3 @@ ZeebeTestRule.assertThat(processInstance)
     .hasPassed("start", "task", "end")
     .hasVariable("result", 21.0);
 ```
-
diff --git a/docs/apis-clients/overview.md b/docs/apis-clients/overview.md
@@ -31,7 +31,7 @@ Clients allow applications to do the following:
 
 Clients connect to Camunda Cloud via [gRPC](https://grpc.io), a high-performance, open-source, and universal RPC protocol.
 
-Camunda Cloud provides several offical clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (e.g. thread handling for job workers) on top of the core API.
+Camunda Cloud provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (e.g. thread handling for job workers) on top of the core API.
 
 Community clients supplement the official clients. These clients have not been tested by Camunda.
 
@@ -50,4 +50,4 @@ Community clients supplement the official clients. These clients have not been t
 - [Rust](community-clients/rust.md)
 - [Spring](community-clients/spring.md)
 
-Finally, it is possible to [build your own client](build-your-own-client.md) if none of the other options are suitable.
+Finally, it is possible to [build your own client](build-your-own-client.md) if none of the other options are suitable.
diff --git a/docs/apis-clients/public-api.md b/docs/apis-clients/public-api.md
@@ -7,13 +7,12 @@ Camunda Cloud provides a public API. This section covers the definition of the p
 
 ## Backwards compatibility for public API
 
-Camunda Cloud versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [Semantic Versioning](https://semver.org/). Camunda Cloud will
+Camunda Cloud versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda Cloud will
 maintain public API backwards compatibility for `MINOR` version updates.
 
 Example: Update from version `1.0.x` to `1.1.y` will not break the public API.
 
-To learn more about our release cycle, refer to our [release
-policy](/reference/release-policy.md).
+To learn more about our release cycle, refer to our [release policy](/reference/release-policy.md).
 
 ## Definition of public API
 
@@ -22,13 +21,10 @@ Currently, both Zeebe API and [Tasklist API](/apis-clients/tasklist-api/generate
 - [Zeebe Client Java API](/apis-clients/java-client/index.md)
 - [Tasklist API](/apis-clients/tasklist-api/generated.md)
 
-All non-implementation Java packages (package name does not contain `impl`) of the following maven modules.
+All non-implementation Java packages (package name does not contain `impl`) of the following Maven modules.
 
 - `io.camunda:zeebe-client-java`
 
 ## Other APIs and clients
 
-Although we cannot currently guarantee backwards comptability of other APIs and clients, we aim to offer backwards compatibility still on a best
-effort basis.
-
-[//]:# (Thoughts on a better way to word the sentence above?)
+Currently, we cannot *guarantee* backwards compatibility with other APIs and clients, though we do work to offer backwards compatibility to the best of our ability.
diff --git a/docs/apis-clients/tasklist-api/generated.md b/docs/apis-clients/tasklist-api/generated.md
@@ -9,7 +9,7 @@ This documentation has been automatically generated from the GraphQL schema.
 
 Use the docs in the sidebar to find out how to use the schema:
 
-- **Allowed operations**: queries and mutations.
-- **Schema-defined types**: scalars, objects, enums, interfaces, unions, and input objects.
+- **Allowed operations**: Queries and mutations.
+- **Schema-defined types**: Scalars, objects, enums, interfaces, unions, and input objects.
 
 <small><i>Generated on 12/16/2021, 5:19:28 PM.</i></small>
diff --git a/docs/components/best-practices.md b/docs/components/best-practices.md
@@ -1,6 +1,7 @@
 ---
 id: best-practices
 title: Best Practices
+description: "Similar to our Camunda Best Practices, we offer Best Practices with a mix of conceptual and practical implementation information for working with Camunda Cloud."
 ---
 
 Similar to our [Camunda Best Practices](https://camunda.com/best-practices/_/), we offer Best Practices with a mix of conceptual and practical implementation information for working with Camunda Cloud. Currently, these are available through blog posts and our [Best Practices hub](https://camunda.com/best-practices/_/).
@@ -19,4 +20,4 @@ Find our Camunda Cloud and BMPN-focused material below:
 * [Naming BPMN Elements](https://camunda.com/best-practices/naming-bpmn-elements/)
 * [Creating Readable Process Models](https://camunda.com/best-practices/creating-readable-process-models/)
 
-This page is updated as more Best Practices are made available.
+This page will be updated as more Best Practices are made available.
diff --git a/...tices/architecture/deciding-about-your-stack-assets/greenfield-architecture.png b/...tices/architecture/deciding-about-your-stack-assets/greenfield-architecture.png
diff --git a/...best-practices/architecture/deciding-about-your-stack-assets/greenfield-architecture.pptx b/...best-practices/architecture/deciding-about-your-stack-assets/greenfield-architecture.pptx
diff --git a/...es/architecture/deciding-about-your-stack-c7-assets/greenfield-architecture.png b/...es/architecture/deciding-about-your-stack-c7-assets/greenfield-architecture.png
diff --git a/...t-practices/architecture/deciding-about-your-stack-c7-assets/greenfield-architecture.pptx b/...t-practices/architecture/deciding-about-your-stack-c7-assets/greenfield-architecture.pptx