search

PelionIoT / pelion-quick-start-web-app

Sample quick start application for Web Apps built on Pelion Device management
Apache License 2.0
4 stars 7 forks source link

Initial questions on documentation #7

Open melwee01 opened 4 years ago

melwee01 commented 4 years ago

Questions on this repository and logistics:

Questions about content:

Questions about related documentation:

froeba commented 4 years ago

Questions on this repository and logistics:

  • Who is this documentation intended for?

Users trying out the new quick start guide for creating web apps based on pelion device management

  • What is their skill level?

Low to no skills with web technology, possibly more advanced with embedded development.

  • What do they need to know? What don't they need to know?

Embedded tech, mbed os will not be required here. Having a device online through the quick-start guide will be. Some understanding of web applications is useful

  • How will this be published?

    • README in this repository?
    • Part of the Pelion website?
    • Does this impose any limitations on what we can do or how we format?

pelion.com and additional information in this repo. We will encourage modification and exploration of the code.

  • How will we maintain this once published, if at all?

similar to current quick-start guides

  • Does working directly with the APIs mean I can write my app in a language other than the ones covered by the SDKs?

yes, this one is available in TypeScript / JavaScript

Questions about content:

  • What prerequisites are there?

Device online in an account using quick-start or other mbed-cloud-client

  • How do I make sure my app isn't broken by API changes?

Check back for changes to this quick start guide

  • Might be a different way of phrasing the same question: How would I, as a user, keep up with API changes?

No answer from me

  • What's the function of the Postgres DB? What fetches what info from it? Is that something the Pelion services do, or does it all go through my webapp?

The DB is to store device resource data in a time-series format for later use. This is handled by the web app as Pelion DM does not store historical data of the resource values.

  • How does any of this integrate with my device app?

Separate from the device app, allows to subscribe to specific resources on the device.

Questions about related documentation:

  • Will the SDK documentation stay in the same place?

Undecided from product. Will probably be phased out