Commit 4386590
authored
Add documentation about related items in solution template guide (#637)
* docs(iot-hub): document related items in solution template guide
Explain the automatic widget FQN resolution that IoT Hub performs when a
solution template ZIP is uploaded:
- new "Related Items" section: how FQNs resolve against system bundles,
that relations are derived from dashboard exports with nothing to
declare, that unresolved FQNs block the upload wizard, and how users
see and receive related widgets on install
- install flow now mentions the related items list and lists related
widgets as the first provisioning stage
- pre-upload checklist requires every non-system widget to be published
with an approved version
- link the Widget Contribution Guide from See Also
* docs(iot-hub): correct related items against the scanner implementation
Address review on #637. The section described a mechanism that differed
from solution-template-scan.service.ts on four points, all verified
against the iot-hub sources:
- the scan reads every .json entry in the archive, not only dashboards/
- the key collected is typeFullFqn, not fqn
- system widgets are dropped by a `system.` prefix test before any
lookup, not compared against widget bundles; note that this makes the
test a spelling test a hand-edited export can defeat
- the blocking guarantee holds only for the create / add-version wizard;
replacing the package on an existing version is deliberately
non-blocking, and a failed scan leaves the step valid
Also:
- drop the claim that the public listing page shows related widgets and
the related-widgets-first provisioning order — neither is backed by
this repo or the creator portal
- note that the wizard labels the step "Required items"
- settle on "system widget" / "IoT Hub widget" throughout
- record that a suspended creator's widget stops resolving
- rename the blocking subsection to a noun phrase, bold the in-page link
- make the checklist item actionable by naming typeFullFqn
- reconcile ${item-link} guidance: widgets are derived automatically, so
reserve the card for dependencies the platform cannot detect
* docs(iot-hub): write related items at the contributor's level
Rewrite the Related Items section so it describes what a creator does and
sees rather than how the scanner works, and fix three reader-facing errors.
- Missing widgets on a package replace render as the same red error, not a
warning; only the title changes. "Warning" names a different state in the
same panel (package unreadable / marketplace unreachable).
- The pre-upload checklist told contributors to search the dashboard export
for typeFullFqn, contradicting the scan's actual scope; it now says every
.json file in the package.
- Standardise on Published for the live version status, matching the Status
column in the Creator Portal. Corrects the status tables in all six
contribution guides, which called it Approved.
Also drop implementation detail with no reader consequence (request batching,
what is retained when a scan fails), rewrite the system. prefix aside as an
instruction not to hand-edit typeFullFqn, replace internal component names
(version drawer, stepper) with the labels shown on screen, un-wrap the
platform's scan steps from <Steps> which elsewhere marks reader actions, and
reduce the "widgets are derived automatically" fact from four restatements to
one canonical section plus cross-references.1 parent 9501f05 commit 4386590
6 files changed
Lines changed: 63 additions & 10 deletions
File tree
- src/content/docs/docs/iot-hub/contribution-guides
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
320 | 320 | | |
321 | 321 | | |
322 | 322 | | |
323 | | - | |
| 323 | + | |
324 | 324 | | |
325 | 325 | | |
326 | 326 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
282 | 282 | | |
283 | 283 | | |
284 | 284 | | |
285 | | - | |
| 285 | + | |
286 | 286 | | |
287 | 287 | | |
288 | 288 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1212 | 1212 | | |
1213 | 1213 | | |
1214 | 1214 | | |
1215 | | - | |
| 1215 | + | |
1216 | 1216 | | |
1217 | 1217 | | |
1218 | 1218 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
436 | 436 | | |
437 | 437 | | |
438 | 438 | | |
439 | | - | |
| 439 | + | |
440 | 440 | | |
441 | 441 | | |
442 | 442 | | |
| |||
Lines changed: 58 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| |||
427 | 427 | | |
428 | 428 | | |
429 | 429 | | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
430 | 479 | | |
431 | 480 | | |
432 | 481 | | |
| |||
599 | 648 | | |
600 | 649 | | |
601 | 650 | | |
602 | | - | |
| 651 | + | |
603 | 652 | | |
604 | 653 | | |
605 | 654 | | |
| |||
618 | 667 | | |
619 | 668 | | |
620 | 669 | | |
621 | | - | |
| 670 | + | |
622 | 671 | | |
623 | 672 | | |
624 | | - | |
| 673 | + | |
625 | 674 | | |
626 | 675 | | |
627 | 676 | | |
628 | 677 | | |
| 678 | + | |
| 679 | + | |
629 | 680 | | |
630 | 681 | | |
631 | 682 | | |
| |||
713 | 764 | | |
714 | 765 | | |
715 | 766 | | |
| 767 | + | |
716 | 768 | | |
717 | 769 | | |
718 | 770 | | |
| |||
746 | 798 | | |
747 | 799 | | |
748 | 800 | | |
749 | | - | |
| 801 | + | |
750 | 802 | | |
751 | 803 | | |
752 | 804 | | |
| |||
772 | 824 | | |
773 | 825 | | |
774 | 826 | | |
| 827 | + | |
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
310 | 310 | | |
311 | 311 | | |
312 | 312 | | |
313 | | - | |
| 313 | + | |
314 | 314 | | |
315 | 315 | | |
316 | 316 | | |
| |||
0 commit comments