Add Azure IoT Hub integration documentation #528
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
@adriansmares sorry for a bunch of suggestions, but I think these tweaks will improve the readability (especially for the first time readers).
P.S. I added suggestions to place some images below their description (i.e. if the description says "select the DIgital Twin then the image with this button showed should go below), just because it's something we enforce though all our guides
I also think that we can remove the old Azure guide
| - **Creating and deleting devices**: manage end device in Azure IoT Hub, using the [LoRaWAN device repository](https://github.com/TheThingsNetwork/lorawan-devices) | ||
| - **Updating device state in Device Twin**: update the device reported properties based on the decoded payloads, and schedule downlinks based on the device desired properties | ||
|
|
||
| This integration comes with a Azure Resource Manager Template template to deploy in your Azure account. |
There was a problem hiding this comment.
Suggested change
| This integration comes with a Azure Resource Manager Template template to deploy in your Azure account. | |
| {{< note >}} This integration comes with a [Azure Resource Manager Template](https://azure.microsoft.com/en-us/services/arm-templates/) template to deploy in your Azure account. {{</ note >}} |
doc/content/integrations/cloud-integrations/azure-iot-hub/architecture.md
Show resolved
Hide resolved
|
|
||
| ## Create API Key | ||
|
|
||
| Go to your application in {{% tts %}} Console, go to **Azure IoT Hub** and click **Generate API Key**. |
There was a problem hiding this comment.
Suggested change
| Go to your application in {{% tts %}} Console, go to **Azure IoT Hub** and click **Generate API Key**. | |
| Go to your application in {{% tts %}} Console, navigate to **Integrations → Azure IoT Hub** on the left hand menu and click **Generate API Key**. |
|
|
||
| <!--more--> | ||
|
|
||
| Download the latest template from [here](https://ttsiothubintegration.blob.core.windows.net/integration-releases/latest/main.json) |
There was a problem hiding this comment.
Suggested change
| Download the latest template from [here](https://ttsiothubintegration.blob.core.windows.net/integration-releases/latest/main.json) | |
| > Download the latest template from [here](https://ttsiothubintegration.blob.core.windows.net/integration-releases/latest/main.json) |
| {{< figure src="../deployments.png" alt="Deployments" >}} | ||
|
|
||
| In the top-right, click **Redeploy**. |
There was a problem hiding this comment.
Suggested change
| {{< figure src="../deployments.png" alt="Deployments" >}} | |
| In the top-right, click **Redeploy**. | |
| In the top-right, click **Redeploy**. | |
| {{< figure src="../deployments.png" alt="Deployments" >}} |
| {{< figure src="../deployment-1.png" alt="Deployment View" >}} | ||
|
|
||
| Click **Edit template**. |
There was a problem hiding this comment.
Suggested change
| {{< figure src="../deployment-1.png" alt="Deployment View" >}} | |
| Click **Edit template**. | |
| Click **Edit template**. | |
| {{< figure src="../deployment-1.png" alt="Deployment View" >}} |
| {{< figure src="../load-template-1.png" alt="Edit Template" >}} | ||
|
|
||
| Click **Load file** and select the template you have just downloaded. |
There was a problem hiding this comment.
Suggested change
| {{< figure src="../load-template-1.png" alt="Edit Template" >}} | |
| Click **Load file** and select the template you have just downloaded. | |
| Click **Load file** and select the template you have just downloaded. | |
| {{< figure src="../load-template-1.png" alt="Edit Template" >}} |
Comment on lines
31
to
33
| {{< figure src="../deployment-1.png" alt="Deployment View" >}} | ||
|
|
||
| Create a new API key as described in the [Deployment Guide]({{< relref "deployment" >}}). Provide the API key for `Stack API Key`. |
There was a problem hiding this comment.
Suggested change
| {{< figure src="../deployment-1.png" alt="Deployment View" >}} | |
| Create a new API key as described in the [Deployment Guide]({{< relref "deployment" >}}). Provide the API key for `Stack API Key`. | |
| Now, create a new API key as described in the [Deployment Guide]({{< relref "deployment" >}}). Provide the created API key for **Stack API Key**. | |
| {{< figure src="../deployment-1.png" alt="Deployment View" >}} |
adriansmares
force-pushed
the
doc/azure-iot-hub
branch
from
6e096fe
to
1b26007
Compare
nejraselimovic
approved these changes
Aug 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
References https://github.com/TheThingsIndustries/lorawan-stack/issues/2808
Changes
Should we deleted the
microsoft-azureintegration guide, given that it is no longer that relevant ?Checklist
make server, posted screenshots, verified external links. Test withHUGO_PARAMS_SEARCH_ENABLED=trueif style changes will affect the search bar.new-in-versionshortcode, according to the guidelines in CONTRIBUTING.