Skip to content

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

Merged
merged 4 commits into from
Feb 11, 2022

Conversation

TwistedTwigleg
Copy link
Contributor

@TwistedTwigleg TwistedTwigleg commented Jan 25, 2022

Description of changes:

This PR makes a few minor changes to the README in the samples folder. The changes are:

  • Removes text mentioning the interactive mode in the pub-sub sample
  • Changes path to root CA to path to root CA1 to clarify which CA file is expected in the pub-sub sample
  • Adds a section for running the pub-sub example using websockets
    • I'm not totally sure if the linked AWS document is the one that should be pointed to - there may be a better file to point to.
  • Added a command example to the Raw MQTT Pub-Sub sample. Also added a sentence mentioning the use of exit to quit the sample.
  • Added a command example to the Shadow sample. Also added a sentence mentioning the use of quit to quit the sample.
  • Changed the policy for the Jobs sample to the policy found at this page on the AWS documentation
    • The current policy shown on the Jobs sample did not work and would give an error code of 5138 when used.
  • Added a command example to the Jobs sample. Also added a note about Service Error 4 occurred and how it might indicate that the job ID may be incorrectly inputted
    • Not totally sure if this is necessary to mention, but it was a little confusing to me initially.

Currently 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.

@TwistedTwigleg TwistedTwigleg force-pushed the SampleMarkdownAdjustment branch from a61446d to 4c88442 Compare January 27, 2022 15:35
@TwistedTwigleg TwistedTwigleg marked this pull request as ready for review January 27, 2022 15:38
Copy link
Contributor

@bretambrose bretambrose left a comment

Choose a reason for hiding this comment

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

Fix n ship

@@ -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>
Copy link
Contributor

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

To run using Websockets, use the following command:

``` sh
./basic-pub-sub --endpoint <endpoint> --topic <topic name> --ca_file <path to root CA1>
Copy link
Contributor

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

To run the Raw MQTT Pub-Sub sample use the following command:

``` sh
./raw-pub-sub --endpoint <endpoint> --ca_file <path to root CA1>
Copy link
Contributor

Choose a reason for hiding this comment

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

similar comment

To run the Shadow sample use the following command:

``` sh
./shadow-sync --endpoint <endpoint> --ca_file <path to root CA1>
Copy link
Contributor

Choose a reason for hiding this comment

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

and here too

@TwistedTwigleg TwistedTwigleg force-pushed the SampleMarkdownAdjustment branch from 10e3c3b to 0538e62 Compare February 11, 2022 14:09
@TwistedTwigleg TwistedTwigleg merged commit 89e17e9 into aws:main Feb 11, 2022
@TwistedTwigleg
Copy link
Contributor Author

Thanks! PR merged 👍

@TwistedTwigleg TwistedTwigleg deleted the SampleMarkdownAdjustment branch February 11, 2022 14:11
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.

2 participants