Install a kit

A kit installs a site's structure in one step: content types, vocabularies with their terms, collections, forms, menus and starter pages, with optional sample content. Four kits ship with Spillway (higher education, city, intranet portal, nonprofit), plus the docs kit that holds this documentation as a site.

Before you start: a manager or admin account on a site that has finished the setup wizard. Installing never overwrites what already exists, so you can do this on a site that has content.

Steps

In the admin, open Structure → Kits. Each card lists what the kit contains (types, vocabularies, collections, forms, pages, sample items). Choose Install and confirm in the dialog.
Choose Install with sample content on the kit you want. Pick Install instead when you only want the structure.
Read the report. Every item is listed as created, updated or skipped with a reason; on a fresh site nothing should be skipped. The starter home page from the setup wizard is replaced by the kit's home page when you have not edited it.
Open the site. The kit's pages are published and in the main menu.

From a terminal, the same thing is:

spillway kit list
spillway kit install higher_ed --sample

Or over the API: POST /api/kits/higher_ed/install with { "withSampleContent": true }.

Check the result

Structure → Kits shows the kit as installed with its version. A fresh site reports a few items as updated (the setup wizard's home page and menus); that is normal.
GET /api/kits returns "installed": true for the key.
The finder page of the kit (for example /programs for higher education) answers 200, and a keyword typed into its search box narrows the list.
Installing the kit a second time reports 0 created, 0 updated.

Going further

Kits and config as code: the manifest format, $term: and $media: references, and how to export your own site's structure for git.
Build a kit with an agent when you want a kit for your own sector.
CLI reference for spillway kit and its flags.

Spillway 0.1.0 · Edit this page on GitHub