From 9f6f4eeedb6f87e2c31e6a6061a715cbdb833267 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= <anarcat@debian.org>
Date: Tue, 22 Oct 2019 16:30:59 -0400
Subject: [PATCH] add a service description template (#30881)

This is the full mounty, and most services will not have everything in
there. But it should cover most of the stuff described in the
checklist (#30881).
---
 tsa/howto/template.mdwn | 63 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 tsa/howto/template.mdwn

diff --git a/tsa/howto/template.mdwn b/tsa/howto/template.mdwn
new file mode 100644
index 00000000..5ef9c15b
--- /dev/null
+++ b/tsa/howto/template.mdwn
@@ -0,0 +1,63 @@
+<!-- include a simple ovrview of the service here -->
+
+[[!toc levels=3]]
+
+<!-- note: this template was designed based on multiple sources: -->
+<!-- https://www.divio.com/blog/documentation/ -->
+<!-- http://opsreportcard.com/section/9-->
+<!-- http://opsreportcard.com/section/11 -->
+<!-- comments like this one should be removed on instanciation -->
+
+# Tutorial
+
+<!-- simple, brainless step-by-step instructions requiring little or -->
+<!-- no technical background -->
+
+# How-to
+
+<!-- more in-depth procedure that may require interpretation -->
+
+## Pager playbook
+## Disaster recovery
+
+# Reference
+
+## Installation
+<!-- how to setup the service from scratch -->
+
+## Design
+<!-- how this is build -->
+<!-- should reuse and expand on the "proposed solution", it's a -->
+<!-- "as-built" documented, whereas the "Proposed solution" is an -->
+<!-- "architectural" document, which the final result might differ -->
+<!-- from, sometimes significantly -->
+
+## SLA
+<!-- this describes an acceptable level of service for this service -->
+
+# Discussion
+
+## Overview
+
+## Goals
+<!-- include bugs to be fixed -->
+
+### Must have
+
+### Nice to have
+
+### Approvals required
+<!-- for example, legal, "vegas", accounting -->
+
+## Non-Goals
+
+## Proposed Solution
+
+## Security
+
+## Disaster Recovery
+<!-- specifically for the launch -->
+
+## Cost
+
+## Alternatives considered
-- 
GitLab