Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 3.4 KB

README.md

File metadata and controls

37 lines (28 loc) · 3.4 KB

Datasets

One manifest per dataset: core-1.json, core-3.json, and full-7.json. The builder reads its settings from the manifest, and command-line options override them.

Dataset People Campuses Photos (decision 30) Check images
Core 1 Cast 1 Every Cast person Every check
Core 3 Cast plus 75 companion households each at Peoria and Gilbert, more involved than the Crowd (decision 142) 3 Cast, plus about half of companions Every check, about 7 to 8 a week (decision 143)
Full 7 Cast plus the Crowd: 16,800 generated households across all seven campuses, the main campus included (decision 136) 7 Cast only Last 12 months

Manifest settings

Setting Meaning
key The dataset key, as passed to --dataset.
name The display name.
generatedHouseholds.perCampus Generated households to add at each campus, keyed by campus key. A campus not listed gets none, and every key must be one of the dataset's campuses. --crowd replaces it (decision 49).
photos.generatedHouseholdPercent Percent of each campus's generated households that get faces from the photo pool. 0 or missing means none.
checkImages.months Months of check gifts, counting back from the anchor date, that get scanned check images. 0 means every check. Used only when the builder runs with --check-images; --check-image-months overrides it.

The manifest grows as the builder reads more settings from it. Campuses are listed per dataset in ../configuration/campuses.json.

The dataset card

Rock's installer shows a card for each dataset, so a church admin can choose one (decision 124). The loader embeds these fields and serves them as SampleDataDatasets (see the loader README). Each release also copies them into its entries in the package index, so a card change reaches Rock with the next release (decision 144). Every field is required, and the builder refuses a manifest that is missing one.

Field Meaning
summary One or two plain sentences: who is in the dataset.
bestFor One plain sentence: what the dataset is best for.
highlights Two to four short phrases.
people, households People and family households (businesses included) a load adds, measured from a real load at the default seed and 3 years of history. Verify fails a load more than 2% away from either.
campuses The dataset's campuses. Must match ../configuration/campuses.json.
typicalInstallSeconds The median of three measured loads of every part, check images included, in whole seconds.
databaseSpaceMegabytes The disk space the database needs: its data and log files at their largest after a load of every part, check images included, in megabytes. Take it from the verify receipt (load.space, each file's fileAfterMb, added together) and round up to the next 100 MB. It includes the new Rock install the load starts from.

Write the text for a church admin choosing what to install. Follow the content standards and the writing rules in AGENTS.md: plain, short sentences and no em dashes. Leave out numbers the number fields already give, so the text never goes stale.