The Good Docs Project schema v1.0

Built-in id: tgdp:templates:1.0

Published at: https://hawkeyexl.github.io/manni/schemas/tgdp/1.0.json

Requires type and closes it to the 25 template slugs published by The Good Docs Project. It is the closed form in one file. tgdp:templates:1.1 with its strict overlay makes the same check, split in two. The open schema requires type and recommends the slugs, and the overlay closes type to them. The 1.1 page lists the 25 slugs by pack.

Use it

TGDP is not in the default set.

manni.config.yaml

meta:
  schemas:
    - tgdp:templates:1.0
    - google:okf:0.1

Fields

Field	Type	Required	Values
type	string	Yes	One of the 25 template slugs

Additional properties

Allowed. The schema says nothing about any key but type.

Example

---
type: installation-guide
title: Install the collector
---

A common mistake

The enum carries no aliases, so a slug has to match exactly. howto is not how-to, so this page fails.

$ manni meta validate page.md --no-config -s tgdp:templates:1.0
✗ page.md
    /type  must be equal to one of the allowed values  (line 2)  [tgdp:templates:1.0]

1 file checked, 0 passed, 1 failed, 1 error