Skip to content

Instantly share code, notes, and snippets.

@eshellman

eshellman/dual_metadata.asciidoc

Last active August 29, 2015 14:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save eshellman/c4cad5018d35b852cfcc to your computer and use it in GitHub Desktop.
Save eshellman/c4cad5018d35b852cfcc to your computer and use it in GitHub Desktop.
Download ZIP
dual metadata repos.
Raw
dual_metadata.asciidoc

dual metadata repos.

There’s a problem I’ve been stewing over.

What’s the best way to organize collections of metadata into repos?

Solution 1: keep the metadata file in the repo with the book. People who know the book are best positioned to accept pull requests.

Solution 2: keep the metadata files in a separate repo just for metadata. Metadata specialists are better positioned to make sure the metadata is clean and uniform.

New solution: Dual metadata. keep the metadata files in both book and metadata repos. Have a bot that syncs them. Have a flexible mechanism to let maintainers have sync commits go directly to master or to require approval.

Byproduct: Use same sync mechanism to allow delegation/syncing of entity metadata, for example metadata about authors of a book. (like foreign keys in a relational db)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment