From c7a4e538554b5f1dab23b91eeaf464d0a0154464 Mon Sep 17 00:00:00 2001 From: Eliise Date: Thu, 2 Sep 2021 14:50:16 +0000 Subject: [PATCH] Update wording --- docs/Command-List.md | 4 +--- docs/Usage.md | 49 +++++++++++++++++++++++++++++++++----------- iotedgedev/cli.py | 3 +-- 3 files changed, 39 insertions(+), 17 deletions(-) diff --git a/docs/Command-List.md b/docs/Command-List.md index 657dde4..91b6d87 100644 --- a/docs/Command-List.md +++ b/docs/Command-List.md @@ -286,9 +286,7 @@ Usage: iotedgedev iothub deploy [OPTIONS] Options: -f, --file TEXT Specify the deployment manifest file [default: config/deployment.amd64.json] - -n, --name TEXT Specify the name of the deployment that will be created in the IoT hub. Give your - deployment a unique name that is up to 128 lowercase letters. Avoid spaces and the - following invalid characters: & ^ [ ] { } \ | " < > /. [required] + -n, --name TEXT Specify the name of the deployment that will be created in the IoT hub. [required] -p, --priority TEXT Specify the deployment priority as positive integer. In the event that two or more deployments are targeted at the same device, the deployment with the highest numerical value for Priority will apply. [required] diff --git a/docs/Usage.md b/docs/Usage.md index d98541a..1e7ef55 100644 --- a/docs/Usage.md +++ b/docs/Usage.md @@ -10,7 +10,9 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Initialize IoT Edge solution and setup Azure resources** - `iotedgedev init` + ```sh + iotedgedev init + ``` `iotedgedev init` will run both `iotedgedev new .` and `iotedgedev iothub setup`, which will create a new solution and setup your Azure resources in a single command. @@ -20,13 +22,17 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Add modules to IoT Edge solution** - `iotedgedev add ` + ```sh + iotedgedev add + ``` Currently the available template values are `c`, `csharp`, `java`, `nodejs`, `python`, `csharpfunction`. We are working on supporting more templates. 1. **Build IoT Edge module images** - `sudo iotedgedev build` + ```sh + sudo iotedgedev build + ``` You can avoid `sudo` if you are running IoT Edge Dev Tool outside Docker container, and: * You are on Windows or macOS. @@ -34,7 +40,9 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Setup the [IoT Edge Simulator]((https://pypi.org/project/iotedgehubdev/).)** - `sudo iotedgedev setup` + ```sh + sudo iotedgedev setup + ``` IoT Edge Simulator does not support running Python and C modules yet. You'll need IoT Edge Runtime to run your Python and C modules. @@ -42,7 +50,9 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Start the IoT Edge Simulator to run the solution** - `sudo iotedgedev start` + ```sh + sudo iotedgedev start + ``` You can also combine setup and start with `sudo iotedgedev start --setup` @@ -52,11 +62,15 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Monitor messages sent from IoT Edge Simulator to IoT Hub** - `iotedgedev monitor` + ```sh + iotedgedev monitor + ``` 1. **Stop the IoT Edge Simulator** - `sudo iotedgedev stop` + ```sh + sudo iotedgedev stop + ``` You can avoid `sudo` if you are running IoT Edge Dev Tool outside Docker container, and: * You are on Windows or macOS. @@ -69,7 +83,9 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Push IoT Edge module images** - `sudo iotedgedev push` + ```sh + sudo iotedgedev push + ``` You can avoid `sudo` if you are running IoT Edge Dev Tool outside Docker container, and: * You are on Windows or macOS. @@ -77,13 +93,22 @@ Note: See the ["Test Coverage"](test-coverage) wiki page to see what the IoT Edg 1. **Deploy modules to IoT Edge device** - `iotedgedev deploy` + ```sh + iotedgedev deploy + ``` + You can also combine push and deploy with `iotedgedev push --deploy` -1. **Create deployments on IoT Hub** +1. **Deploy modules with automatic deployments to IoT Hub** - `iotedgedev iothub deploy` + ```sh + iotedgedev iothub deploy + ``` + + > More information on how automatic deployments work can be found here: 1. **Monitor messages sent from IoT Edge Runtime to IoT Hub** - `iotedgedev monitor` + ```sh + iotedgedev monitor + ``` diff --git a/iotedgedev/cli.py b/iotedgedev/cli.py index facf06e..f683783 100644 --- a/iotedgedev/cli.py +++ b/iotedgedev/cli.py @@ -262,8 +262,7 @@ main.add_command(deploy) @click.option("--name", "-n", required=True, - help=("Specify the name of the deployment that will be created in the IoT hub. " - "Give your deployment a unique name that is up to 128 lowercase letters. Avoid spaces and the following invalid characters: & ^ [ ] { } \\ | \" < > /.")) + help="Specify the name of the deployment that will be created in the IoT hub.") @click.option("--priority", "-p", required=True,