search

GoogleCloudPlatform / iot-device-sdk-embedded-c

Cloud IoT Device SDK for Connectivity to IoT Core.
Other
247 stars 83 forks source link

Docs updates #24

Closed soyrice closed 5 years ago

soyrice commented 5 years ago

Documentation updates/additions to the release notes, repo readme, user guide, porting guide, and example readme files.

soyrice commented 5 years ago

I think that some of the older version of the document snuck into this Pull Request. I had done some work to the use of the term "client" to refer to our SDK. I tried to tag all of those locations that I found where it should be updated again.

Great work overall though! Let me know when you want me to make another pass.

Thanks for catching that. I changed the mentions of "client" to "Device SDK", using "Device SDK" instead of "SDK" for the product short name. I'll make another editing pass to catch any typos, etc. The same goes for the porting guide.

googlebot commented 5 years ago

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

Googlers can find more info about SignCLA and this PR by following this link.

googlebot commented 5 years ago

CLAs look good, thanks!

Googlers can find more info about SignCLA and this PR by following this link.

soyrice commented 5 years ago

I a few .DS_Store in the list of commit files, likely mistakenly included

Fixed. Thanks for catching :)

soyrice commented 5 years ago

A heads up: I'm meeting with Tamas tomrrow (Thursday) to update root CA certificate mentions to match. For now, please ignore commit https://github.com/GoogleCloudPlatform/iot-device-sdk-embedded-c/pull/24/commits/3619b4948bf8186af70cf2879aab3c4c3cd2858d.

soyrice commented 5 years ago

A heads up: I'm meeting with Tamas tomrrow (Thursday) to update root CA certificate mentions to match. For now, please ignore commit 3619b49.

After meeting with Tamas, we decided on a plan to document the LTS domains. I finished the updates to the GitHub (the docs are finally updated to match PR #31) and I'm working with the IoT Core team to add more documentation to cloud.google.com.