https://github.com/dastergon/sreworkbook-templates-md

A collection templates ported from the SRE Workbook
https://github.com/dastergon/sreworkbook-templates-md

devops error-budget reliability-engineering site-reliability site-reliability-engineering sla sli slo templates

Last synced: 11 days ago
JSON representation

A collection templates ported from the SRE Workbook

• Host: GitHub
• URL: https://github.com/dastergon/sreworkbook-templates-md
• Owner: dastergon
• License: cc0-1.0
• Created: 2018-08-24T07:32:18.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-24T07:38:07.000Z (about 6 years ago)
• Last Synced: 2024-08-03T15:11:34.732Z (3 months ago)
• Topics: devops, error-budget, reliability-engineering, site-reliability, site-reliability-engineering, sla, sli, slo, templates
• Homepage:
• Size: 4.88 KB
• Stars: 37
• Watchers: 3
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - dastergon/sreworkbook-templates-md - A collection templates ported from the SRE Workbook (devops)

README

        
# SRE Workbook - Markdown Templates

This is a collection of ported Markdown templates included in ["The Site Reliability Engineering Workbook"](https://landing.google.com/sre/book.html) regarding the Service Level Objectives and Error Budget Policy documents.

Full description of each section can be found in ["The Site Reliability Engineering Workbook"](https://landing.google.com/sre/book.html).

## Template List

* [Error Budget Policy Template](error-budget.md)

* [SLO Document Template](slo-document.md)

## Load templates automatically

It is possible to load the templates automatically without copy pasting from the files or manually writing the structure every time you want to author a document.

### Vim

You can add the following line into your `.vimrc` file:

    au BufNewFile error-budget-*.md 0r ~/sreworkbook-templates-md/error-budget.md

    au BufNewFile slo-*.md 0r ~/sreworkbook-templates-md/slo-document.md

### Emacs

You can add the following line into your `.emacs` file:

    (add-hook 'text-mode-hook (lambda () (when (and (string-prefix-p "slo-" (buffer-name)) (= (point-max) (point-min))) (insert-file-contents "~/sreworkbook-templates-md/slo-document.md"))))

    (add-hook 'text-mode-hook (lambda () (when (and (string-prefix-p "error-budget-" (buffer-name)) (= (point-max) (point-min))) (insert-file-contents "~/sreworkbook-templates-md/eror-budget.md"))))

In all cases, if you create a file named based on the `pattern-*`, it will load automatically the predefined template into that file. You can use any naming scheme of your choice.