Commit f2c28a4
Add quickstart sample(#183)
# Adding a AIO Quickstart Process to accelerate dev and experimental
projects
## Destination Repo Structure (explore-iot-operations)
The destination repo is an Azure-Samples collection with existing
content:
```
explore-iot-operations/
├── samples/ # 14 existing code samples (auth servers, WASM, dashboards, etc.)
├── tutorials/ # Event-driven Dapr tutorial
├── tools/ # Schema generation helper
├── docker/ # WASM Rust build container
├── docs/ # Repo organization docs
├── README.md # Root README (codespace-focused getting started)
├── CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md, SECURITY.md, CHANGELOG.md
└── index.html
```
## What Was Migrated
The quickstart content has already been placed under `quickstart/`:
```
quickstart/
├── readme.md # Main quickstart guide
├── README_ADVANCED.md # Detailed technical reference
├── quick_vm_build.md # VM build instructions
├── arc_build_linux/ # Edge installer scripts
├── arm_templates/ # ARM templates
├── config/ # Config templates
├── external_configuration/ # Azure configuration scripts
└── modules/ # Edge modules
├── demohistorian/
└── edgemqttsim/
```
### Content NOT migrated (by design)
These directories from learn-iot are **not** in this repo (they either
don't exist yet, are out of scope, or are handled differently):
| Directory | Reason |
|-----------|--------|
| `Fabric_setup/` | Not yet migrated; referenced in README_ADVANCED.md |
| `operations/` | Dataflow YAML examples; not yet migrated |
| `docs/img/` | Process diagrams; image references will be removed for
now |
| `issues/` | Repo-specific issue tracking; not applicable here |
| `modules/sputnik/` | Not migrated |
| `modules/hello-flask/` | Not migrated |
| `bugfix.md` | Development notes; not applicable |
---
## Changes Required
### 1. `docs/ORGANIZATION.md` — Add quickstart to repo structure
The organization doc currently only describes `samples/` and
`tutorials/`. It needs a new **Quickstart** section to explain the
`quickstart/` directory, its purpose, and how it differs from samples
and tutorials.
**Changes:**
- Add `quickstart/` to the directory tree diagram
- Add a paragraph explaining the quickstart's purpose and scope
- Preserve all existing content about samples and tutorials
### 2. `README.md` (root) — Add quickstart entry point
The root README currently focuses on the GitHub Codespaces experience.
The quickstart is a complementary path for deploying on real hardware or
AKS Edge Essentials.
**Changes:**
- Add a "Quickstart: Deploy on Real Hardware" section after the existing
Getting Started
- Brief description with a link to `quickstart/readme.md`
- Mention that the quickstart is for production-oriented deployments vs.
the codespace path
- Keep all existing content intact (codespace badge, existing Getting
Started, Contributing, etc.)
### 3. `quickstart/readme.md` — Fix references for new repo context
All internal paths and clone URLs currently reference
`BillmanH/learn-iot`. These need to point to the correct locations
within this repo.
**Key changes:**
- **Clone URL**: `BillmanH/learn-iot` →
`Azure-Samples/explore-iot-operations`
- **ZIP download URL**: Updated similarly
- **Clone target directory**: `learn-iot` → `explore-iot-operations`
- **Working directory**: After clone, `cd` into `quickstart/`
- **Relative path references**: Paths like
`arc_build_linux/installer.sh` are correct (relative to `quickstart/`)
- **Image reference**: `` —
removed (image not migrated)
- **Image references**: `` and
`` — removed
- **Fabric setup link**: Updated to note content is in the source repo
or removed
- **Issue tracker link**: Updated to this repo's issues
- **Context framing**: Add a note that this quickstart lives within the
larger explore-iot-operations repo
### 4. `quickstart/README_ADVANCED.md` — Fix internal references
**Key changes:**
- **Repository structure diagram**: `learn-iothub/` → updated to reflect
`quickstart/` layout
- **References to `iotopps/`**: The source repo used `iotopps/` for edge
apps; this repo uses `modules/`. Update all references.
- **Clone/download references**: Same URL updates as the main readme
- **Fabric setup link**:
`fabric_setup/fabric-realtime-intelligence-setup.md` → note not migrated
- **Diagnostic script paths**: Already correct (relative to
`arc_build_linux/`)
---
## What This Plan Does NOT Change
- **No file moves or renames** — all quickstart files stay under
`quickstart/`
- **No code changes** — scripts, templates, and application code are
untouched
- **No changes to existing samples/** — all 14 existing samples remain
as-is
- **No changes to tutorials/** — existing tutorial content is preserved
- **No changes to tools/, docker/, .devcontainer/** — infrastructure
files untouched
- **No changes to CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md,
SECURITY.md, CHANGELOG.md**
---------
Co-authored-by: william_harding <wharding@microsoft.com>1 parent e7dedcd commit f2c28a4
68 files changed
Lines changed: 17634 additions & 70 deletions
File tree
- docs
- quickstart
- arc_build_linux
- arm_templates
- config
- external_configuration
- modules
- demohistorian
- edgemqttsim
- samples
- aio-onvif-connector-ptz-demo
- Aio.Onvif.Connector.Ptz.Demo
- auth-server-user-pass-mqtt
- docs
- layered-networking
- observability
- grafana-dashboard
- process-control/process-control-demo/src/write.dataset.client
- tools/schema-gen-helper
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
422 | 422 | | |
423 | 423 | | |
424 | 424 | | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
| 12 | + | |
| 13 | + | |
11 | 14 | | |
12 | 15 | | |
13 | | - | |
| 16 | + | |
14 | 17 | | |
15 | 18 | | |
16 | 19 | | |
17 | 20 | | |
18 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
19 | 26 | | |
20 | 27 | | |
21 | 28 | | |
| |||
36 | 43 | | |
37 | 44 | | |
38 | 45 | | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
39 | 76 | | |
40 | 77 | | |
41 | 78 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
8 | 16 | | |
9 | 17 | | |
10 | 18 | | |
| |||
13 | 21 | | |
14 | 22 | | |
15 | 23 | | |
| 24 | + | |
| 25 | + | |
16 | 26 | | |
| 27 | + | |
17 | 28 | | |
18 | 29 | | |
19 | 30 | | |
| |||
0 commit comments