Skip to content

Commit

Permalink
Update broken links in demo comments and documentation. (#1552)
Browse files Browse the repository at this point in the history
* Update broken links in demo comments and documentation.

This is to fix the Github issue #1546

* Fix spell checks

* Address review comments
  • Loading branch information
leegeth authored Feb 24, 2021
1 parent d410219 commit 7069921
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 15 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,14 +325,13 @@ Dependency | Version | Usage

#### AWS IoT Account Setup

You need to setup an AWS account and access the AWS IoT console for running the AWS IoT Device Shadow library, AWS IoT Device Defender library, AWS IoT Jobs library,
AWS IoT OTA library and coreHTTP S3 download demos.
Also, the AWS account can be used for running the MQTT mutual auth demo can be run against AWS IoT broker.
Also, running the AWS IoT Device Defender, AWS IoT Jobs and AWS IoT Device Shadow library demos require the setup of a Thing resource for the device running the
demo.
You need to setup an AWS account and access the AWS IoT console for running the AWS IoT Device Shadow library, AWS IoT Device Defender library, AWS IoT Jobs library,
AWS IoT OTA library and coreHTTP S3 download demos.
Also, the AWS account can be used for running the MQTT mutual auth demo against AWS IoT broker.
Note that running the AWS IoT Device Defender, AWS IoT Jobs and AWS IoT Device Shadow library demos require the setup of a Thing resource for the device running the demo.
Follow the links to:
- [Setup an AWS account](https://portal.aws.amazon.com/billing/signup#/start).
- [Sign-in to the AWS IoT Console](https://aws.amazon.com/console/) after setting up the AWS account.
- [Sign-in to the AWS IoT Console](https://console.aws.amazon.com/iot/home) after setting up the AWS account.
- [Create a Thing resource](https://docs.aws.amazon.com/iot/latest/developerguide/iot-moisture-create-thing.html).


Expand Down
4 changes: 2 additions & 2 deletions demos/mqtt/mqtt_demo_mutual_auth/demo_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
*
* Refer to the AWS IoT documentation below for details regarding client
* authentication with a username and password.
* https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-authentication.html
* https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
* As mentioned in the link above, an authorizer setup needs to be done to use
* username/password based client authentication.
*
Expand All @@ -137,7 +137,7 @@
*
* Refer to the AWS IoT documentation below for details regarding client
* authentication with a username and password.
* https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-authentication.html
* https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
* As mentioned in the link above, an authorizer setup needs to be done to use
* username/password based client authentication.
*
Expand Down
4 changes: 2 additions & 2 deletions demos/mqtt/mqtt_demo_mutual_auth/mqtt_demo_mutual_auth.c
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
* 2. Define CLIENT_USERNAME and CLIENT_PASSWORD in demo_config.h for client
* authentication to be done using a username and password. More details about
* this client authentication can be found in the link below.
* https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-authentication.html
* https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
* An authorizer setup needs to be done, as mentioned in the above link, to use
* username/password based client authentication.
*
Expand Down Expand Up @@ -1056,7 +1056,7 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
/* Use the username and password for authentication, if they are defined.
* Refer to the AWS IoT documentation below for details regarding client
* authentication with a username and password.
* https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-authentication.html
* https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
* An authorizer setup needs to be done, as mentioned in the above link, to use
* username/password based client authentication.
*
Expand Down
2 changes: 1 addition & 1 deletion demos/ota/ota_demo_core_http/ota_demo_core_http.c
Original file line number Diff line number Diff line change
Expand Up @@ -1166,7 +1166,7 @@ static int establishMqttSession( MQTTContext_t * pMqttContext )
/* Use the username and password for authentication, if they are defined.
* Refer to the AWS IoT documentation below for details regarding client
* authentication with a username and password.
* https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-authentication.html
* https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
* An authorizer setup needs to be done, as mentioned in the above link, to use
* username/password based client authentication.
*
Expand Down
2 changes: 1 addition & 1 deletion demos/ota/ota_demo_core_mqtt/ota_demo_core_mqtt.c
Original file line number Diff line number Diff line change
Expand Up @@ -1040,7 +1040,7 @@ static int establishMqttSession( MQTTContext_t * pMqttContext )
/* Use the username and password for authentication, if they are defined.
* Refer to the AWS IoT documentation below for details regarding client
* authentication with a username and password.
* https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-authentication.html
* https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
* An authorizer setup needs to be done, as mentioned in the above link, to use
* username/password based client authentication.
*
Expand Down
10 changes: 7 additions & 3 deletions docs/doxygen/building.dox
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ Linux platform. This SDK builds with [CMake](https://cmake.org/), a cross-platfo
@section aws_iot_setup AWS IoT Account Setup
@brief Setting up AWS IoT to run demos.

It is required to setup an AWS account and access the AWS IoT Console for running demos and tests. Follow the links to:
- [Setup an AWS account](https://docs.aws.amazon.com/iot/latest/developerguide/iot-console-signin.html).
- [Sign-in to the AWS IoT Console](https://docs.aws.amazon.com/iot/latest/developerguide/iot-console-signin.html) after setting up the AWS account.
You need to setup an AWS account and access the AWS IoT console for running the AWS IoT Device Shadow library, AWS IoT Device Defender library, AWS IoT Jobs library,
AWS IoT OTA library and coreHTTP S3 download demos.
Also, the AWS account can be used for running the MQTT mutual auth demo against AWS IoT broker.
Note that running the AWS IoT Device Defender, AWS IoT Jobs and AWS IoT Device Shadow library demos require the setup of a Thing resource for the device running the demo.
- [Setup an AWS account](https://portal.aws.amazon.com/billing/signup#/start).
- [Sign-in to the AWS IoT Console](https://console.aws.amazon.com/iot/home) after setting up the AWS account.
- [Create a Thing resource](https://docs.aws.amazon.com/iot/latest/developerguide/iot-moisture-create-thing.html).

@section configuring_mutual_auth_demo Configuring the Mutual Auth Demo
@brief Passing configuration settings to run the mutual auth demo.
Expand Down
1 change: 1 addition & 0 deletions docs/lexicon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ sdk
sha
signedheaders
signin
signup
sigterm
somehash
src
Expand Down

0 comments on commit 7069921

Please sign in to comment.