thin-edge/thin-edge.io

Improve Connecting to AWS IoT documentation

Closed this issue · 2 comments

Is your documentation request related to a problem? Please describe.

Some of the problems with the existing instructions are:

  • The instructions are hard to read and many steps are combined into a sentence rather than in a numbered list
  • AWS policy example requires users to manually edit which is very easy to get wrong
  • ca-certificate instructions are not consistent with advice to use the update-ca-certificates command

Describe the improvement you'd like

  • reformat to use numbered list for sequence instructions
  • investigate if there is a better way to add more user-context to the instructions (e.g. let the user enter their own AWS IoT Core url etc.

Additional context

The new AWS connection docs (with user-context) has now been deployed.

https://thin-edge.github.io/thin-edge.io/start/connect-aws/

  • The changes introduced in this PR significantly enhance the quality and usability of the thin-edge.io documentation.

  • The updated and new content is accurate, comprehensive, and well-structured, providing a better resource for users.