style(formatting): technical review

camunda · Dec 13, 2023 · 9dea177 · 9dea177
1 parent 1ba1855
commit 9dea177
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 57 deletions.
diff --git a/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md b/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md
@@ -1,29 +1,27 @@
 ---
 id: running-custom-connectors
-title: "Running Custom Connectors"
-description: "Run custom Connectors in your Helm K8S cluster"
+title: "Running custom Connectors"
+description: "Run custom Connectors in your Helm Kubernetes cluster."
 ---
 
-You can deploy your custom **Connector** in your Helm K8S cluster along with Connectors Bundle.
-
-## Overview
+You can deploy your custom **Connector** in your Helm Kubernetes cluster along with Connectors Bundle.
 
 The default runtime loads Connectors from classpath via SPI. For the custom Connectors, there is a dedicated folder
-inside a **Connectors** Docker image `/opt/custom`. Any jar that is placed there will be included into the classpath.
+inside a **Connectors** Docker image `/opt/custom`; any JAR placed here is included in the classpath.
 
 This page explains how to put your custom Connector into the `/opt/custom`.
 
 ## Prerequisites
 
-Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' jar (jar with dependencies) of your custom **Connector**. For the purpose of
-this guide, let's consider the custom **Connector** name as `custom-connector-0.0.1-with-dependencies.jar`.
+Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' JAR (JAR with dependencies) of your custom **Connector**. For the purpose of
+this guide, let's consider the custom **Connector** name `custom-connector-0.0.1-with-dependencies.jar`.
 
-Then, you need to place the 'fat' jar somewhere accessible by Helm during installation. For the purpose of this guide,
+Then, place the JAR somewhere accessible by Helm during installation. For the purpose of this guide,
 let's consider the path to the **Connector** is `https://my.host:80/dist/custom-connector-0.0.1-with-dependencies.jar`.
 
 ## Modify Connectors config
 
-Modify the `values.yaml` file in the [Camunda Helm Charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml).
+Modify the `values.yaml` file in the [Camunda Helm charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml):
 
 ```yaml
 connectors:
@@ -49,14 +47,13 @@ connectors:
 ```
 
 After modification, you can run `helm install ... ` as usual.
-These changes will copy a custom Connector jar before the Connector runtime starts.
+These changes copy a custom Connector JAR before the Connector runtime starts.
 
-The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives
-that you can use, for example `curlimages/curl`. Please check `args` configuration with your vendor.
+The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives you can use; for example, `curlimages/curl`. Check `args` configuration with your vendor.
 
 ## Troubleshooting
 
 If your custom Connector won't start, consider the following troubleshooting steps:
 
 - Make sure your Connector is present in the `/opt/custom` folder in the pod.
-- Make sure that the original Connector and the one in the `/opt/custom` are the same. Usually, file size check is sufficient but in some cases you may want to have a checksum comparison.
+- Make sure the original Connector and the one in `/opt/custom` are the same. Usually, file size check is sufficient, but in some cases you may want to have a checksum comparison.
diff --git a/optimize_sidebars.js b/optimize_sidebars.js
@@ -1795,7 +1795,7 @@ module.exports = {
                   "self-managed/platform-deployment/helm-kubernetes/guides/aws-marketplace"
                 ),
                 docsLink(
-                  "Running Custom Connectors",
+                  "Running custom Connectors",
                   "self-managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors"
                 ),
               ],

diff --git a/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md b/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md
@@ -1,29 +1,27 @@
 ---
 id: running-custom-connectors
-title: "Running Custom Connectors"
-description: "Run custom Connectors in your Helm K8S cluster"
+title: "Running custom Connectors"
+description: "Run custom Connectors in your Helm Kubernetes cluster."
 ---
 
-You can deploy your custom **Connector** in your Helm K8S cluster along with Connectors Bundle.
-
-## Overview
+You can deploy your custom **Connector** in your Helm Kubernetes cluster along with Connectors Bundle.
 
 The default runtime loads Connectors from classpath via SPI. For the custom Connectors, there is a dedicated folder
-inside a **Connectors** Docker image `/opt/custom`. Any jar that is placed there will be included into the classpath.
+inside a **Connectors** Docker image `/opt/custom`; any JAR placed here is included in the classpath.
 
 This page explains how to put your custom Connector into the `/opt/custom`.
 
 ## Prerequisites
 
-Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' jar (jar with dependencies) of your custom **Connector**. For the purpose of
-this guide, let's consider the custom **Connector** name as `custom-connector-0.0.1-with-dependencies.jar`.
+Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' JAR (JAR with dependencies) of your custom **Connector**. For the purpose of
+this guide, let's consider the custom **Connector** name `custom-connector-0.0.1-with-dependencies.jar`.
 
-Then, you need to place the 'fat' jar somewhere accessible by Helm during installation. For the purpose of this guide,
+Then, place the JAR somewhere accessible by Helm during installation. For the purpose of this guide,
 let's consider the path to the **Connector** is `https://my.host:80/dist/custom-connector-0.0.1-with-dependencies.jar`.
 
 ## Modify Connectors config
 
-Modify the `values.yaml` file in the [Camunda Helm Charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml).
+Modify the `values.yaml` file in the [Camunda Helm charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml):
 
 ```yaml
 connectors:
@@ -49,14 +47,13 @@ connectors:
 ```
 
 After modification, you can run `helm install ... ` as usual.
-These changes will copy a custom Connector jar before the Connector runtime starts.
+These changes copy a custom Connector JAR before the Connector runtime starts.
 
-The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives
-that you can use, for example `curlimages/curl`. Please check `args` configuration with your vendor.
+The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives you can use; for example, `curlimages/curl`. Check `args` configuration with your vendor.
 
 ## Troubleshooting
 
 If your custom Connector won't start, consider the following troubleshooting steps:
 
 - Make sure your Connector is present in the `/opt/custom` folder in the pod.
-- Make sure that the original Connector and the one in the `/opt/custom` are the same. Usually, file size check is sufficient but in some cases you may want to have a checksum comparison.
+- Make sure the original Connector and the one in `/opt/custom` are the same. Usually, file size check is sufficient, but in some cases you may want to have a checksum comparison.
diff --git a/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md b/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md
@@ -1,29 +1,27 @@
 ---
 id: running-custom-connectors
-title: "Running Custom Connectors"
-description: "Run custom Connectors in your Helm K8S cluster"
+title: "Running custom Connectors"
+description: "Run custom Connectors in your Helm Kubernetes cluster."
 ---
 
-You can deploy your custom **Connector** in your Helm K8S cluster along with Connectors Bundle.
-
-## Overview
+You can deploy your custom **Connector** in your Helm Kubernetes cluster along with Connectors Bundle.
 
 The default runtime loads Connectors from classpath via SPI. For the custom Connectors, there is a dedicated folder
-inside a **Connectors** Docker image `/opt/custom`. Any jar that is placed there will be included into the classpath.
+inside a **Connectors** Docker image `/opt/custom`; any JAR placed here is included in the classpath.
 
 This page explains how to put your custom Connector into the `/opt/custom`.
 
 ## Prerequisites
 
-Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' jar (jar with dependencies) of your custom **Connector**. For the purpose of
-this guide, let's consider the custom **Connector** name as `custom-connector-0.0.1-with-dependencies.jar`.
+Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' JAR (JAR with dependencies) of your custom **Connector**. For the purpose of
+this guide, let's consider the custom **Connector** name `custom-connector-0.0.1-with-dependencies.jar`.
 
-Then, you need to place the 'fat' jar somewhere accessible by Helm during installation. For the purpose of this guide,
+Then, place the JAR somewhere accessible by Helm during installation. For the purpose of this guide,
 let's consider the path to the **Connector** is `https://my.host:80/dist/custom-connector-0.0.1-with-dependencies.jar`.
 
 ## Modify Connectors config
 
-Modify the `values.yaml` file in the [Camunda Helm Charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml).
+Modify the `values.yaml` file in the [Camunda Helm charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml):
 
 ```yaml
 connectors:
@@ -49,14 +47,13 @@ connectors:
 ```
 
 After modification, you can run `helm install ... ` as usual.
-These changes will copy a custom Connector jar before the Connector runtime starts.
+These changes copy a custom Connector JAR before the Connector runtime starts.
 
-The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives
-that you can use, for example `curlimages/curl`. Please check `args` configuration with your vendor.
+The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives you can use; for example, `curlimages/curl`. Check `args` configuration with your vendor.
 
 ## Troubleshooting
 
 If your custom Connector won't start, consider the following troubleshooting steps:
 
 - Make sure your Connector is present in the `/opt/custom` folder in the pod.
-- Make sure that the original Connector and the one in the `/opt/custom` are the same. Usually, file size check is sufficient but in some cases you may want to have a checksum comparison.
+- Make sure the original Connector and the one in `/opt/custom` are the same. Usually, file size check is sufficient, but in some cases you may want to have a checksum comparison.
diff --git a/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md b/...managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors.md
@@ -1,29 +1,27 @@
 ---
 id: running-custom-connectors
-title: "Running Custom Connectors"
-description: "Run custom Connectors in your Helm K8S cluster"
+title: "Running custom Connectors"
+description: "Run custom Connectors in your Helm Kubernetes cluster."
 ---
 
-You can deploy your custom **Connector** in your Helm K8S cluster along with Connectors Bundle.
-
-## Overview
+You can deploy your custom **Connector** in your Helm Kubernetes cluster along with Connectors Bundle.
 
 The default runtime loads Connectors from classpath via SPI. For the custom Connectors, there is a dedicated folder
-inside a **Connectors** Docker image `/opt/custom`. Any jar that is placed there will be included into the classpath.
+inside a **Connectors** Docker image `/opt/custom`; any JAR placed here is included in the classpath.
 
 This page explains how to put your custom Connector into the `/opt/custom`.
 
 ## Prerequisites
 
-Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' jar (jar with dependencies) of your custom **Connector**. For the purpose of
-this guide, let's consider the custom **Connector** name as `custom-connector-0.0.1-with-dependencies.jar`.
+Start with [creating and building](../../../../components/connectors/custom-built-connectors/connector-sdk.md) a 'fat' JAR (JAR with dependencies) of your custom **Connector**. For the purpose of
+this guide, let's consider the custom **Connector** name `custom-connector-0.0.1-with-dependencies.jar`.
 
-Then, you need to place the 'fat' jar somewhere accessible by Helm during installation. For the purpose of this guide,
+Then, place the JAR somewhere accessible by Helm during installation. For the purpose of this guide,
 let's consider the path to the **Connector** is `https://my.host:80/dist/custom-connector-0.0.1-with-dependencies.jar`.
 
 ## Modify Connectors config
 
-Modify the `values.yaml` file in the [Camunda Helm Charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml).
+Modify the `values.yaml` file in the [Camunda Helm charts repository](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/values.yaml):
 
 ```yaml
 connectors:
@@ -49,14 +47,13 @@ connectors:
 ```
 
 After modification, you can run `helm install ... ` as usual.
-These changes will copy a custom Connector jar before the Connector runtime starts.
+These changes copy a custom Connector JAR before the Connector runtime starts.
 
-The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives
-that you can use, for example `curlimages/curl`. Please check `args` configuration with your vendor.
+The `appropriate/curl` is not the only image option for the `initContainers`. There are other `curl`-based alternatives you can use; for example, `curlimages/curl`. Check `args` configuration with your vendor.
 
 ## Troubleshooting
 
 If your custom Connector won't start, consider the following troubleshooting steps:
 
 - Make sure your Connector is present in the `/opt/custom` folder in the pod.
-- Make sure that the original Connector and the one in the `/opt/custom` are the same. Usually, file size check is sufficient but in some cases you may want to have a checksum comparison.
+- Make sure the original Connector and the one in `/opt/custom` are the same. Usually, file size check is sufficient, but in some cases you may want to have a checksum comparison.