Skip to content

Instantly share code, notes, and snippets.

@wheresrhys

wheresrhys/strawman.md

Last active January 18, 2019 15:46
Show Gist options
  • Save wheresrhys/5a83e95f6b55ee3fb2707b6833053300 to your computer and use it in GitHub Desktop.
Save wheresrhys/5a83e95f6b55ee3fb2707b6833053300 to your computer and use it in GitHub Desktop.
Download ZIP
Runbooks in repos
Raw
strawman.md

Runbooks in repos straw man proposal

open questions

  • discovery of repos that contain docs - how. pull or push model
  • default docs folder name & structure. Coexistence with other docs?
  • discourage linking to people & teams? (Too hard to bulk change?)
  • how to avoid having to list refs to each .md file
  • how to put properties related to a md file with the content e.g. failOverInfo = free text field => md file failOverType = enum => ... front matter in md file?

biz-ops.yaml/.json

code: biz-ops-admin
implementsPatterns: 
	- api-gateway
	- heroku-app
name: ...
dependencies: 
	- biz-ops-api
troubleshooting: docs/troubleshooting.md

How patterns work

Records in biz-ops which implement [a subset of] System type

Runbooks exist for

  • systems
  • patterns

System runbooks link to pattern runbooks

@sjparkinson
Copy link

If you're going for it, implementsPatterns -> patterns.

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