Notes on GETTING_STARTED.md

[melwee01]

• Who is this document for?
• What is 'this app' and what's my goal here?
• What are the prerequisites? There's a pin in this, at least, with the Required heading, but we need links to https://www.pelion.com/docs/device-management/current/user-account/api-keys.html
• APP_HOST - URL of the application to be deployed - https://.herokuapp.com/ -> This assumes a lot. How have I gotten to this point? Is there an example I can see? If this is what I'm doing in this tutorial, then it's not a prerequisite. The order now says I need to have an app before I create one.
• The next heading, Deploy from Github, seems to imply that there's an example app I can use. Do I have to use it? Or do I skip that if I have my own already?
  • What limitations are there on my app, if any?
  • What if I've developed an app with the SDKs? Can I use a mixture of APIs and SDK abstraction?
  • Step 5 explains that is the app name. However, I already needed to know what meant in the previous section.
• 'Set config vars' doesn't make any sense when I first encounter it. Use a different phrasing until you explain the concept.
• When I set up the database integration, does that have any legal repercussions?
  • What can or can't I use my app for using this method?
  • Can I charge people for my service and app if I set it up this way?
• Check for issues -> 'logs should show no errors'. What if they do?
• 'it is time to view the app' -> Once the application is confirmed to be running in the logs and the config vars are set, click Open App.

[froeba]

• Who is this document for?

New users intending to deploy this app to Heroku

• What is 'this app' and what's my goal here?

This app creates a simple web server and visualisation for storing device data from PDM

• What are the prerequisites? There's a pin in this, at least, with the Required heading, but we need links to https://www.pelion.com/docs/device-management/current/user-account/api-keys.html

Having successfully completed the quick connect guide, user should have a device online and be familiar with the portal. Also, capable of supplying an API key

• APP_HOST - URL of the application to be deployed - https://.herokuapp.com/ -> This assumes a lot. How have I gotten to this point? Is there an example I can see? If this is what I'm doing in this tutorial, then it's not a prerequisite. The order now says I need to have an app before I create one.

It's a cross-dependency of sorts. Create the app and the name you create supplies the APP_HOST requirement. I wish it were simpler, but not possible yet.

• The next heading, Deploy from Github, seems to imply that there's an example app I can use. Do I have to use it? Or do I skip that if I have my own already?

This is the example app to use.

• What limitations are there on my app, if any?

The free database from heroku limits to 10,000 rows which can be achieved in fairly short time period

• What if I've developed an app with the SDKs? Can I use a mixture of APIs and SDK abstraction?

This is purely for direct API usage as SDKs are no longer available. If you want to mix it with the SDK that is always possible.

• Step 5 explains that is the app name. However, I already needed to know what meant in the previous section.

yes, it might be confusing

• 'Set config vars' doesn't make any sense when I first encounter it. Use a different phrasing until you explain the concept.

could be environment variables? The terminology on the web site is Config Vars

• When I set up the database integration, does that have any legal repercussions?

Possibly.

• What can or can't I use my app for using this method?

Anything you like, just keep in mind that authentication is not included, everything is visible from the internet.

• Can I charge people for my service and app if I set it up this way?

Legal question. This app is to help get started so it should be either be heavily modified beyond recognition or re-written before they get to that point.

• Check for issues -> 'logs should show no errors'. What if they do?

Then try to identify what it missing. Troubleshooting section needs expanding.

• 'it is time to view the app' -> Once the application is confirmed to be running in the logs and the config vars are set, click Open App.

:-) and the question is?