acrolinx

asergaz · asergaz · commit b5802101a460 · 2025-07-18T01:14:58.000+01:00
diff --git a/articles/iot-operations/develop-edge-apps/overview-iot-operations-sdks.md b/articles/iot-operations/develop-edge-apps/overview-iot-operations-sdks.md
@@ -22,7 +22,7 @@ The Azure IoT Operations SDKs are a suite of tools and libraries across multiple
 | **Low latency** | Optimized layering and tight MQTT client coupling minimized overheads. |
 | **Integration with Azure IoT Operations services** | Libraries provide access to services such as state store. |
 | **Simplify complex messaging** | Provide support for communication between applications via MQTT v5 using a remote procedure call (RPC) implementation. |
-| **Support** | The SDKs are maintained and supported by a dedicated team at Microsoft. |
+| **Support** | A dedicated team at Microsoft maintains and supports the SDKs. |
 
 The SDKs are open source and available on GitHub:
 
@@ -32,7 +32,7 @@ The SDKs are open source and available on GitHub:
 
 > [!IMPORTANT]
 > Azure IoT Operations SDKs is currently in PREVIEW.
-> The assets in the [Azure IoT Operations SDKs GitHub repository](https://github.com/Azure/iot-operations-sdks) have been made available for early access and feedback purposes.
+> The assets in the [Azure IoT Operations SDKs GitHub repository](https://github.com/Azure/iot-operations-sdks) are available for early access and feedback purposes.
 
 ## Goal of the SDKs
 
@@ -42,25 +42,25 @@ The SDKs can be used to build highly available applications at the edge, that in
 
 ## Benefits of using the SDKs
 
-The SDKs provide a number of benefits compared to using the MQTT client directly:
+The SDKs provide many benefits compared to using the MQTT client directly:
 
 | Feature | Benefit |
 |-|-|
 | **Connectivity** | Maintain a secure connection to the MQTT Broker, including rotating server certificates and authentication keys. |
 | **Security** | Support SAT or X.509 certificate authentication with credential rotation. |
-| **Configuration** | Configure the MQTT Broker connection through the file system, environment or connection string. |
+| **Configuration** | Configure the MQTT Broker connection through the file system, environment, or connection string. |
 | **Services** | Provides client libraries to Azure IoT Operations services for simplified development. |
-| **Protocol Compiler (codegen)** | Provides contract guarantees between client and servers via RPC and telemetry. |
-| **High availability** | Building blocks for building highly available apps via state store, lease lock and leader election clients. |
+| **Protocol Compiler (codegen)** | Provides contract guarantees between client and servers via RPC and Telemetry. |
+| **High availability** | Building blocks for building highly available apps via state store, lease lock, and leader election clients. |
 | **Payload formats** | Supports multiple serialization formats, built in. |
 
 ## Components of the SDKs
 
-The SDKs provide a number of components available for simplicity and ease of use:
+The SDKs provide many components available for simplicity and ease of use:
 
-* A **session client**, that augments the MQTT client, adding reconnection and authentication to provide a seamless connectivity experience.
+* A **session client** that augments the MQTT client adding reconnection and authentication to provide a seamless connectivity experience.
 
-* A set of protocol primitives, designed to assist in creating applications, built on the fundamental protocol implementations: **Commands** and **Telemetry**. 
+* A set of protocol primitives, designed to help creating applications, built on the fundamental protocol implementations: **Commands** and **Telemetry**. 
 
 * A set of clients providing integration with Azure IoT Operations services such as **state store**, **leader election**, **lease lock**, and **schema registry**.
 
@@ -78,10 +78,10 @@ The SDKs supports the following application types:
 | Application type | Description |
 |-|-|
 | [Edge application](https://github.com/Azure/iot-operations-sdks/blob/main/doc/edge_application/README.md) | A generic edge application that needs to interface with various Azure IoT Operations services such as the MQTT broker and state store. The SDKs provides convenient clients to simplify the development experience. </br></br>*An Edge Application is a customer managed artifact, including deployment to the cluster and monitoring execution.* |
-| [Akri connector](https://github.com/Azure/iot-operations-sdks/blob/main/doc/akri_connector/README.md)</br>*(in development)*| A specialized edge application deployed by the Akri Operator and designed to interface with on-premises asset endpoints. The Akri connector is responsible for discovering assets available via the endpoint, and relaying information to and from those assets.</br></br>*The Akri connector's deployment is managed automatically by the Akri Operator.* |
+| [Akri connector](https://github.com/Azure/iot-operations-sdks/blob/main/doc/akri_connector/README.md)</br>*(in development)*| A specialized edge application deployed by the Akri Operator and designed to interface with on-premises asset endpoints. The Akri connector is responsible for discovering assets available via the endpoint, and relaying information to and from those assets. </br></br>*The Akri connector's deployment is managed automatically by the Akri Operator.* |
 
 > [!NOTE]
-> The Akri connector is part of the Akri services (preview), which is under active development and will be available in the near future.
+> The Akri connector is part of the Akri services (preview), which is under active development and will be available soon.
 
 ## Samples and tutorials
 
@@ -91,7 +91,7 @@ To deploy a fully functional application to a cluster and see the SDKs in action
 
 ## SDKs reference documentation
 
-For documentation related to the implementation of the SDKs, it's fundamentals primitives and protocols as well as the underlying topic and payload structure used for communication over MQTT, see [Azure IoT Operatios SDKs reference documentation](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/README.md).
+For documentation related to the implementation of the SDKs, it's fundamentals primitives and protocols as well as the underlying topic and payload structure used for communication over MQTT, see [Azure IoT Operations SDKs reference documentation](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/README.md).
 
 ## Next step
 
diff --git a/articles/iot-operations/develop-edge-apps/quickstart-get-started-sdks.md b/articles/iot-operations/develop-edge-apps/quickstart-get-started-sdks.md
@@ -25,23 +25,23 @@ Before you begin, prepare the following prerequisites:
 
 ## Setting up
 
-Developing with the Azure IoT Operations SDKs requires a Kubernetes cluster with Azure IoT Operations deployed. Additional configuration will allow the MQTT broker to be accessed directly from the developer environment.
+Developing with the Azure IoT Operations SDKs requires a Kubernetes cluster with Azure IoT Operations deployed. Further configuration allows the MQTT broker to be accessed directly from the developer environment.
 
 > [!IMPORTANT]
 > The following development environment setup options, use [K3s](https://k3s.io/) running in [K3d](https://k3d.io/) for a lightweight Kubernetes cluster, and deploys Azure IoT Operations with [test settings](../deploy-iot-ops/overview-deploy.md#test-settings-deployment). For production deployments, choose [secure settings](../deploy-iot-ops/overview-deploy.md#secure-settings-deployment). <br> If you want to use secure settings, we recommend you follow the instructions in [Prepare your Azure Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-prepare-cluster.md) to create a K3s cluster on Ubuntu and [Deploy Azure IoT Operations to a production cluster](../deploy-iot-ops/howto-deploy-iot-operations.md) to deploy with secure settings. Then proceed to [configure Azure IoT Operations for deployment](#configure-azure-iot-operations-for-deployment).
 
 ### [Codespaces](#tab/codespaces)
 
 > [!CAUTION]
-> We are currently experiencing container corruption with Azure IoT Operations deployed in a codespace, so we don't recommend this path until we have resolved the issue with the GitHub team.
+> We're currently experiencing container corruption with Azure IoT Operations deployed in a codespace, so we don't recommend this path until we resolve the issue with the GitHub team.
 
 GitHub Codespaces provides the most streamlined experience and can get the development environment up and running in a couple of minutes.
 
 1. Create a **codespace** in GitHub Codespaces from the *Azure IoT Operations SDKs* repository:
 
     [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure/iot-operations-sdks?quickstart=1&editor=vscode)
 
-1. Once the codespace is created, you will have a container with the developer tools and a local K3s cluster running in K3d pre-installed.
+1. Once the codespace is created, you have a container with the developer tools and a local K3s cluster running in K3d preinstalled.
 
 
 ### [Ubuntu](#tab/ubuntu)
@@ -82,13 +82,13 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
     1. Set up port forwarding for ports `1883`, `8883`, and `8884` to enable TLS
     1. Create a local container registry
     
-1. For the nexts step you will need non-root access to the cluster, run the following command:
+1. For the nexts step you need nonroot access to the cluster, run the following command:
 
     ```bash
     mkdir ~/.kube; sudo install -o $USER -g $USER -m 600 /root/.kube/config ~/.kube/config
     ```
 
-    This command gives your non-root user access to the Kubernetes cluster by copying the cluster configuration file from the root account to your user account, ensuring you have the correct permissions to use Kubernetes tools like kubectl without needing root access.
+    This command gives your nonroot user access to the Kubernetes cluster by copying the cluster configuration file from the root account to your user account, ensuring you have the correct permissions to use Kubernetes tools like kubectl without needing root access.
 
 1. Run the following command to increase the [user watch/instance limits](https://www.suse.com/support/kb/doc/?id=000020048).
 
@@ -111,7 +111,7 @@ GitHub Codespaces provides the most streamlined experience and can get the devel
 
 ## Deploy Azure IoT Operations
 
-You will arc-enable the development cluster created in the previous step and deploy Azure IoT Operations with [test settings](../deploy-iot-ops/overview-deploy.md#test-settings-deployment).
+You'll arc-enable the development cluster created in the previous step and deploy Azure IoT Operations with [test settings](../deploy-iot-ops/overview-deploy.md#test-settings-deployment).
 
 Open a new bash terminal and do the following steps:
 
@@ -156,7 +156,7 @@ Open a new bash terminal and do the following steps:
 
 ## Configure Azure IoT Operations for development
 
-After Azure IoT Operations is deployed, you need to configure it for development. This includes setting up the MQTT broker and authentication methods, as well as ensuring that the necessary environment variables are set for your development environment:
+After Azure IoT Operations is deployed, you need to configure it for development. This includes setting up the MQTT broker and authentication methods, and ensuring that the necessary environment variables are set for your development environment:
 
 1. Navigate to the repository root directory:
 
@@ -179,7 +179,7 @@ After Azure IoT Operations is deployed, you need to configure it for development
 
 ## Testing the installation
 
-To test the setup is working correctly, use `mosquitto_pub` to connect to the MQTT broker to validate the x509 certs, SAT and trust bundle.
+To test the setup is working correctly, use `mosquitto_pub` to connect to the MQTT broker to validate the x509 certs, SAT, and trust bundle.
 
 1. Export the `.session` directory:
 
@@ -207,11 +207,11 @@ To test the setup is working correctly, use `mosquitto_pub` to connect to the MQ
 
 ## Run a Sample
 
-This sample demonstrates a simple communication between a client and a server using [telemetry](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/telemetry.md) and [remote procedure call (RPC)](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/rpc-protocol.md). The server tracks the value of a counter and accepts RPC requests from the client to either read or increment that counter.
+This sample demonstrates a simple communication between a client and a server using [Telemetry](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/telemetry.md) and [remote procedure call (RPC)](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/rpc-protocol.md). The server tracks the value of a counter and accepts RPC requests from the client to either read or increment that counter.
 
 1. Install the [.NET 9.0 SDK](https://dotnet.microsoft.com/download/dotnet/9.0)
 
-1. The samples within [Azure IoT Operations SDKs github repository](https://github.com/Azure/iot-operations-sdks) read configuration from environment variables. We have provided an `.env` file in the repository root that exports the variables used by the samples to connect to the MQTT Broker. Edit the `.env` file to set the values for your environment, or use the default values provided in the file.
+1. The samples within [Azure IoT Operations SDKs GitHub repository](https://github.com/Azure/iot-operations-sdks) read configuration from environment variables. We provide an `.env` file in the repository root that exports the variables used by the samples to connect to the MQTT Broker. Edit the `.env` file to set the values for your environment, or use the default values provided in the file.
 
 1. Navigate to the `CounterServer` sample directory:
 
@@ -273,14 +273,14 @@ This sample demonstrates a simple communication between a client and a server us
     CounterServer Information: 0 : Telemetry sent successfully to the topic 'telemetry/telemetry-samples/counterValue'
     ```
 
-1. The `CounterClient` sample will automatically exit when it is completed. You can also stop the `CounterServer` sample by pressing `Ctrl+C` in its terminal.
+1. The `CounterClient` sample automatically exits when it's completed. You can also stop the `CounterServer` sample by pressing `Ctrl+C` in its terminal.
 
 
 ## Configuration summary
 
 ### MQTT broker configuration
 
- With the installation complete, the cluster will contain the following MQTT broker definitions:
+ With the installation complete, the cluster contains the following MQTT broker definitions:
 
 | Component Type | Name | Description |
 |-|-|-|
@@ -292,11 +292,11 @@ This sample demonstrates a simple communication between a client and a server us
 
 ### MQTT broker access
 
-The MQTT broker can be accessed both on-cluster and off-cluster using the connection information below. Refer to [Connection Settings](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/connection-settings.md) for information on which environment variables to use when configuration your application.
+The MQTT broker can be accessed both on-cluster and off-cluster using the connection information as described in the following table. Refer to [Connection Settings](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/connection-settings.md) for information on which environment variables to use when configuration your application.
 
 > [!NOTE]
 >
-> The hostname when accessing the MQTT broker off-cluster may differ from `localhost` depending on your setup.
+> The hostname when accessing the MQTT broker off-cluster might differ from `localhost` depending on your setup.
 
 | Hostname | Authentication | TLS | On cluster port | Off cluster port |
 |-|-|-|-|-|
@@ -319,7 +319,7 @@ As part of the deployment script, the following files are created in the local e
 
 ## Troubleshooting
 
-Check the troubleshooting guide for common issues in the Azure IoT Operations SDKs github repository: [Troubleshooting](https://github.com/Azure/iot-operations-sdks/blob/main/doc/troubleshooting.md).
+Check the troubleshooting guide for common issues in the Azure IoT Operations SDKs GitHub repository: [Troubleshooting](https://github.com/Azure/iot-operations-sdks/blob/main/doc/troubleshooting.md).
 
 ## Next steps
 In this Quickstart, you set up the Azure IoT Operations SDKs and ran a sample application. To learn more about developing with the SDKs, check out the following resources:
