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

[Feature request] Extend walk-through samples for Plug and Play #441

Open
jspaith opened this issue May 24, 2021 · 1 comment
Open

[Feature request] Extend walk-through samples for Plug and Play #441

jspaith opened this issue May 24, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation Plug and Play Feature: Plug and Play related

Comments

@jspaith
Copy link

jspaith commented May 24, 2021

As we're adding official PnP APIs to SDKs, this has forced a much harder look at the SDK documentation. Tagging @momuno who's been doing a lot of this review.

With the thermometer & temp controller E2E DTDLs, we want the SDK docs to help customer get as far as possible for an E2E experience. We certainly push customers to PnP in IoT Explorer, which is a great tool by the way.

I do not want to have the SDKs though documenting "Push this button in IoT explorer" and "Select this drop down." The concern is if you guys change this, the SDK content immediately becomes stale and needs updating many places.

While https://github.com/Azure/azure-iot-explorer#plug-and-play is pretty good, it flies by really fast and doesn't explicitly call out our golden example DTDL of thermostat & tempController.

Please consider either:

@jspaith jspaith added enhancement New feature or request needs review Review required by team member labels May 24, 2021
@rido-min
Copy link
Member

Agreed, we should have a good summary in the README of this repo.

/c @dominicbetts

@YingXue YingXue added documentation Improvements or additions to documentation and removed needs review Review required by team member enhancement New feature or request labels Jul 15, 2021
@YingXue YingXue added the Plug and Play Feature: Plug and Play related label Aug 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Plug and Play Feature: Plug and Play related
Projects
None yet
Development

No branches or pull requests

3 participants