-
Notifications
You must be signed in to change notification settings - Fork 110
Minor modifications to the sample README file #373
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
Minor modifications to the sample README file #373
Conversation
a61446d
to
4c88442
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix n ship
samples/README.md
Outdated
@@ -92,11 +94,28 @@ and receive. | |||
To run the basic MQTT Pub-Sub use the following command: | |||
|
|||
``` sh | |||
./basic-pub-sub --endpoint <endpoint> --ca_file <path to root CA> | |||
./basic-pub-sub --endpoint <endpoint> --ca_file <path to root CA1> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd leave this as is
samples/README.md
Outdated
To run using Websockets, use the following command: | ||
|
||
``` sh | ||
./basic-pub-sub --endpoint <endpoint> --topic <topic name> --ca_file <path to root CA1> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here, just say root CA
samples/README.md
Outdated
To run the Raw MQTT Pub-Sub sample use the following command: | ||
|
||
``` sh | ||
./raw-pub-sub --endpoint <endpoint> --ca_file <path to root CA1> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
similar comment
samples/README.md
Outdated
To run the Shadow sample use the following command: | ||
|
||
``` sh | ||
./shadow-sync --endpoint <endpoint> --ca_file <path to root CA1> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and here too
…with the pub-sub sample
…mple, and the jobs sample
10e3c3b
to
0538e62
Compare
Thanks! PR merged 👍 |
Description of changes:
This PR makes a few minor changes to the README in the
samples
folder. The changes are:path to root CA
topath to root CA1
to clarify which CA file is expected in the pub-sub sampleexit
to quit the sample.quit
to quit the sample.5138
when used.Service Error 4 occurred
and how it might indicate that the job ID may be incorrectly inputtedCurrently I am marking this PR as a draft so I can check the other samples.There's a few samples I skipped for now (PKCS#11, Fleet provisioning, Secure Tunnel, Greengrass) that I will try to come back to in the future.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.