Skip to content

Commit f638155

Browse files
authored
Merge pull request #1349 from rackerlabs/schema-docs-fix-20251020
fix(docs): Fixes the paths for schemas
2 parents 7653f6d + b85cd54 commit f638155

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

docs/design-guide/device-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Each resource class requires:
8080
## Example Definition
8181

8282
```yaml
83-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
83+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
8484
class: server
8585
manufacturer: Dell
8686
model: PowerEdge R7615
@@ -187,7 +187,7 @@ Device type files include a YAML language server directive for editor-based
187187
validation:
188188

189189
```yaml
190-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
190+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
191191
```
192192

193193
The schema enforces:

docs/design-guide/flavors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Flavor definitions are YAML files validated against `schema/flavor.schema.json`.
5858

5959
```yaml
6060
---
61-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
61+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
6262
name: m1.small
6363
resource_class: m1.small
6464
```
@@ -69,7 +69,7 @@ This matches all Ironic nodes with `resource_class=m1.small`, regardless of trai
6969

7070
```yaml
7171
---
72-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
72+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
7373
name: m1.small.nicX
7474
resource_class: m1.small
7575
traits:
@@ -83,7 +83,7 @@ This matches only nodes with `resource_class=m1.small` AND the `CUSTOM_NICX` tra
8383

8484
```yaml
8585
---
86-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
86+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
8787
name: m1.small.no-gpu
8888
resource_class: m1.small
8989
traits:

docs/operator-guide/device-types.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ when added to the deployment.
4545
Start with the YAML language server directive for editor validation:
4646

4747
```yaml
48-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
48+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
4949
class: server
5050
manufacturer: Dell
5151
model: PowerEdge R7615
@@ -416,7 +416,7 @@ If your editor doesn't validate the YAML:
416416
### Server Device Type
417417

418418
```yaml
419-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
419+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
420420
class: server
421421
manufacturer: HPE
422422
model: ProLiant DL360 Gen10
@@ -457,7 +457,7 @@ resource_class:
457457
### Switch Device Type
458458

459459
```yaml
460-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
460+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
461461
class: switch
462462
manufacturer: Cisco
463463
model: Nexus 9336C-FX2
@@ -486,7 +486,7 @@ power-ports:
486486
### Firewall Device Type
487487

488488
```yaml
489-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
489+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
490490
class: firewall
491491
manufacturer: Palo Alto
492492
model: PA-5220
@@ -519,7 +519,7 @@ power-ports:
519519
### Storage Device Type
520520

521521
```yaml
522-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/device-type.schema.json
522+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/device-type.schema.json
523523
manufacturer: NetApp
524524
model: FAS8200
525525
u_height: 3

docs/operator-guide/flavors.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Create a new YAML file with your flavor specification. You can create it anywher
4040
Start with the YAML language server directive for editor validation:
4141

4242
```yaml
43-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
43+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
4444
name: m1.small
4545
resource_class: m1.small
4646
```
@@ -57,7 +57,7 @@ resource_class: m1.small
5757
Define hardware trait requirements to filter which nodes match this flavor:
5858

5959
```yaml
60-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
60+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
6161
name: m1.small.nicX
6262
resource_class: m1.small
6363
traits:
@@ -245,7 +245,7 @@ git push
245245
Match all nodes in a resource class without trait filtering:
246246

247247
```yaml
248-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
248+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
249249
name: compute.standard
250250
resource_class: m1.medium
251251
```
@@ -257,7 +257,7 @@ This provides maximum flexibility by allowing any hardware in the `m1.medium` re
257257
Require specific hardware capabilities:
258258

259259
```yaml
260-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
260+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
261261
name: compute.gpu
262262
resource_class: m1.large
263263
traits:
@@ -272,7 +272,7 @@ Guarantees instances get nodes with GPU hardware.
272272
Require specific network hardware:
273273

274274
```yaml
275-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
275+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
276276
name: m1.small.mellanox-cx5
277277
resource_class: m1.small
278278
traits:
@@ -287,7 +287,7 @@ Only matches nodes with Mellanox ConnectX-5 network cards.
287287
Combine multiple trait requirements:
288288

289289
```yaml
290-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
290+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
291291
name: compute.nvme-no-gpu
292292
resource_class: m1.medium
293293
traits:
@@ -389,7 +389,7 @@ If your editor doesn't validate the YAML:
389389
### Generic Compute Flavor
390390

391391
```yaml
392-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
392+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
393393
name: m1.small
394394
resource_class: m1.small
395395
```
@@ -399,7 +399,7 @@ Matches all nodes in the `m1.small` resource class.
399399
### NIC-Specific Flavor
400400

401401
```yaml
402-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
402+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
403403
name: m1.small.nicX
404404
resource_class: m1.small
405405
traits:
@@ -412,7 +412,7 @@ Only matches nodes with the `CUSTOM_NICX` trait.
412412
### GPU Compute Flavor
413413

414414
```yaml
415-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
415+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
416416
name: compute.gpu
417417
resource_class: m1.large
418418
traits:
@@ -425,7 +425,7 @@ Guarantees GPU hardware for compute workloads.
425425
### Combined Hardware Requirements
426426

427427
```yaml
428-
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/flavor.schema.json
428+
# yaml-language-server: $schema=https://rackerlabs.github.io/understack/schema/flavor.schema.json
429429
name: m1.medium.mellanox-cx5-nvme
430430
resource_class: m1.medium
431431
traits:

0 commit comments

Comments
 (0)