Skip to content
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

Add an onboarding guide URL to end device definitions #754

Closed
KrishnaIyer opened this issue Mar 5, 2024 · 4 comments
Closed

Add an onboarding guide URL to end device definitions #754

KrishnaIyer opened this issue Mar 5, 2024 · 4 comments
Assignees
Milestone

Comments

@KrishnaIyer
Copy link
Member

Summary

I propose to add an onboarding guide URL to end device definitions.

Why do we need this?

To have a link to a document where users can get very specific and direct guide to onboard a particular device.

What is already there? What do you see now?

We currently have a productURL which seems like it's for general product description/marketing and and dataSheetURL which usually has a lot of technical information.

What is missing? What do you want to see?

A onboardingGuideURL that points to documentation that specifically has steps to onboard the device.
Ex: Download App -> Set Params -> Insert battery -> device should send a join request.

We can help device manufacturers with a nice "template" for this in our docs, if they choose to use it.

How do you propose to implement this?

I'll leave that to @LDannijs. Let's first discuss if this is something we'd like to do.

Can you do this yourself and submit a Pull Request?

No but I can help do E2E testing and also come up with the first few guides.

@github-actions github-actions bot added the needs/triage We still need to triage this label Mar 5, 2024
@johanstokking
Copy link
Member

I think this makes sense. Few comments:

  1. We don't need all the standard screenshots like in https://www.thethingsindustries.com/docs/devices/models/browan-tbms100/; we should refer to the existing guide only providing the settings that need to be set
  2. We need to structure this under the vendor ID as a folder
  3. We need to make sure that this is not used to advertise or explain how great the device is
  4. Vendors can also choose to put their own URL in there. It doesn't have to be specific for TTS as long as their page is comprehensive w.r.t. LoRaWAN settings

@KrishnaIyer KrishnaIyer removed the needs/triage We still need to triage this label Mar 6, 2024
@KrishnaIyer KrishnaIyer added this to the Mar 2024 milestone Mar 6, 2024
@KrishnaIyer
Copy link
Member Author

Ok great thanks. @LDannijs can you take this forward?

@LDannijs
Copy link
Contributor

LDannijs commented Mar 6, 2024

Yeah sounds good I'll get on it soon 👍

@KrishnaIyer
Copy link
Member Author

This is closed via #765

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

No branches or pull requests

3 participants