Unverified Commit e62242e5 authored by anarcat's avatar anarcat
Browse files

review the service template after writing the cache service docs 

This includes:

 * moving the SLA upwards, because it's shorter
 * adding an "issues" section to document known problems and a link to
   the bugtracker
 * mention the current service maintainer as an approver
 * remove the launch checklist, that should be in a ticket instead
 * mention benchmarks in the alternatives evaluation
parent f12d790d

tsa/howto/template.mdwn

+14 −8
Original line number Original line Diff line number Diff line
@@ -25,20 +25,28 @@ 
## Installation

## Installation

<!-- how to setup the service from scratch -->

<!-- how to setup the service from scratch -->





## SLA

<!-- this describes an acceptable level of service for this service -->



## Design

## Design

<!-- how this is build -->

<!-- how this is built -->

<!-- should reuse and expand on the "proposed solution", it's a -->

<!-- should reuse and expand on the "proposed solution", it's a -->

<!-- "as-built" documented, whereas the "Proposed solution" is an -->

<!-- "as-built" documented, whereas the "Proposed solution" is an -->

<!-- "architectural" document, which the final result might differ -->

<!-- "architectural" document, which the final result might differ -->

<!-- from, sometimes significantly -->

<!-- from, sometimes significantly -->





## SLA

## Issues

<!-- this describes an acceptable level of service for this service -->



<!-- such projects are never over. add a pointer to well-known issues -->

<!-- and show how to report problems. usually a link to the bugtracker -->





# Discussion

# Discussion





## Overview

## Overview





<!-- describe the overall project. should include a link to a ticket -->

<!-- that has a launch checklist -->



## Goals

## Goals

<!-- include bugs to be fixed -->

<!-- include bugs to be fixed -->
@@ -47,16 +55,14 @@ 
### Nice to have

### Nice to have





### Approvals required

### Approvals required

<!-- for example, legal, "vegas", accounting -->

<!-- for example, legal, "vegas", accounting, current maintainer -->





## Non-Goals

## Non-Goals





## Proposed Solution

## Proposed Solution





## Launch checklist



<!-- include disaster recovery -->



## Cost

## Cost





## Alternatives considered

## Alternatives considered



<!-- include benchmarks and procedure if relevant -->