Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding graphical instructions to the docs showing how to do the cloud steps to get the demo working #14

Open
wants to merge 4 commits into
base: development
Choose a base branch
from

Conversation

spartacoos
Copy link

No description provided.

@LDong-Arm LDong-Arm changed the base branch from master to development November 4, 2020 15:32
@LDong-Arm LDong-Arm requested a review from a team November 4, 2020 15:34
Comment on lines +18 to +44
1. Create an [Azure account](https://azure.microsoft.com/en-gb/free/)
1. Log in to your Azure account and you should see the console below. Click on "Create a resource"
![step1](./resources/Step1.jpg)
1. Click on "IoT Hub" by searching in the bar as shown below
![step2](./resources/Step2.jpg)
1. Click on "Create"
![step3](./resources/Step3.jpg)
1. Fill in the details ensuring the subscription is set to "Free Trial". Choose a resource group, region, and hub name of your choosing
![step4](./resources/Step4.jpg)
1. Ensure "Public endpoint (all networks)" is selected then click on "Next: Size and scale"
![step5](./resources/Step5.jpg)
1. Ensure price is set to "Free tier"
![step6](./resources/Step6.jpg)
1. Add a description of your device as shown below then click "Next: Review and create"
![step7](./resources/Step7.jpg)
1. Click "Create"
![step8](./resources/Step8.jpg)
1. Click "Add and configure IoT Devices"
![step9](./resources/Step9.jpg)
1. Click "New"
![step10](./resources/Step10.jpg)
1. Give an ID name to your device then click "Save"
![step11](./resources/Step11.jpg)
1. Click on the device you have just created
![step12](./resources/Step12.jpg)
1. Copy the Primary Connection String
![step13](./resources/Step13.jpg)
Copy link
Contributor

@LDong-Arm LDong-Arm Nov 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the detailed step-by-step guide. But as an external service it may change over time, a guide (especially one based on screenshots) puts extra maintenance on us - especially one that's based on screenshots. Links may also change, but they are a lot easier to update.
I personally find the official guides (that we linked) from Microsoft fairly easy to follow. @ARMmbed/mbed-os-core Any thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed with @LDong-Arm; the instructions should not be repeated from the external website, it is a non necessary maintenance overhead for the configuration of a third-party SDK.
It would make sense to add more details if several configuration options are provided in the external guide but I don't think it is really applicable here.

Comment on lines +18 to +44
1. Create an [Azure account](https://azure.microsoft.com/en-gb/free/)
1. Log in to your Azure account and you should see the console below. Click on "Create a resource"
![step1](./resources/Step1.jpg)
1. Click on "IoT Hub" by searching in the bar as shown below
![step2](./resources/Step2.jpg)
1. Click on "Create"
![step3](./resources/Step3.jpg)
1. Fill in the details ensuring the subscription is set to "Free Trial". Choose a resource group, region, and hub name of your choosing
![step4](./resources/Step4.jpg)
1. Ensure "Public endpoint (all networks)" is selected then click on "Next: Size and scale"
![step5](./resources/Step5.jpg)
1. Ensure price is set to "Free tier"
![step6](./resources/Step6.jpg)
1. Add a description of your device as shown below then click "Next: Review and create"
![step7](./resources/Step7.jpg)
1. Click "Create"
![step8](./resources/Step8.jpg)
1. Click "Add and configure IoT Devices"
![step9](./resources/Step9.jpg)
1. Click "New"
![step10](./resources/Step10.jpg)
1. Give an ID name to your device then click "Save"
![step11](./resources/Step11.jpg)
1. Click on the device you have just created
![step12](./resources/Step12.jpg)
1. Copy the Primary Connection String
![step13](./resources/Step13.jpg)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed with @LDong-Arm; the instructions should not be repeated from the external website, it is a non necessary maintenance overhead for the configuration of a third-party SDK.
It would make sense to add more details if several configuration options are provided in the external guide but I don't think it is really applicable here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants