Skip to content

Can a directory with a Scripture Burrito manifest contain files not in the Burrito? #331

@jonathanrobie

Description

@jonathanrobie

We agreed on the following today:

📦 Packaging and Realization of a Scripture Burrito

A Scripture Burrito is fundamentally a manifest—a machine-readable metadata.json file that describes the structure and content of a Scripture-related dataset. While it references various artifacts (e.g., Scripture texts, audio files, media), it does not mandate a specific physical form.

The manifest may be realized in different physical containers such as:

  • a file directory

  • a compressed ZIP archive

  • a Git repository

  • a structured XML database

  • a SQLite or other relational database

  • a cloud bucket (e.g., S3)

These realizations are referred to as the host structure or container.

💡 Key Principles

  1. A Scripture Burrito is a manifest.
    It does not mandate any particular physical realization. The same manifest may describe a directory structure, a GitHub repository, a zip file, a database, or another packaging format.

  2. If it is not described by the Burrito, it is not 'in' the Burrito.
    Only resources explicitly described in the metadata.json are considered part of the Scripture Burrito. The presence of additional files in the same container—whether subdirectories, extraneous database records, or unrelated media files—does not imply they are part of the Burrito. Scripture Burrito makes no claim that nothing else exists in the container.

  3. If it is described by the Burrito and cannot be found, it is a referential integrity error.
    If a required file or artifact referenced in the manifest is missing from the container, this constitutes a referential integrity error, and the Scripture Burrito must be considered invalid for processing or validation.

🧩 Terminology Summary

Term Definition
manifest The metadata.json file that describes the structure and references.
container The physical or logical bundle holding Burrito content (e.g., folder, zip).
realization The way a Burrito is instantiated in a container (e.g., directory, zip file).
host structure The enclosing system that stores or serves the Burrito (e.g., repo, bucket).
artifact Any individual resource (file, audio, text, etc.) referenced by the manifest.
location The specific path or URI where an artifact is expected to be found.
binding The mapping between the manifest and the actual files/records it refers to.
referential integrity A state in which all described artifacts are present and locatable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions