Skip to content

Instantly share code, notes, and snippets.

@wheresrhys wheresrhys/strawman.md
Last active Jan 18, 2019

Embed
What would you like to do?
Runbooks in repos

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

This comment has been minimized.

Copy link

sjparkinson commented Jan 18, 2019

discovery of repos that contain docs - how. pull or push model

Push, develop a GitHub App installed on all repositories that can look for changes to the specific files you are interested in.

Happy to support you in this area with what our team has learned.

Pull will inevitably mean you hit GitHub rate limits.

implementsPatterns

Humm, too soon for this? Might be good to see how this initially goes with existing concepts.

A focus on getting us all to better document system dependencies would be a good step forward.

default docs folder name & structure

.financial-times/* given it looks like there might be more and more files appearing?

@sjparkinson

This comment has been minimized.

Copy link

sjparkinson commented Jan 18, 2019

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
You can’t perform that action at this time.