service/donate.md

@@ -22,7 +22,7 @@ branch is deleted.
 
 ## Pager playbook
 
-# Disaster recovery
+## Disaster recovery
 
 In the event that the box is compromised, it should be rebuilt from scratch.
 See [Installation](#installation) below.
@@ -46,6 +46,10 @@ trigger a rebuild.
 TODO: The `renovate-cron` project should be enabled here to ensure timely
 upgrades to the staging and production deployments.
 
+## SLA
+
+<!-- this describes an acceptable level of service for this service -->
+
 ## Design and architecture
 
 There are three major pieces to donate-review:
@@ -81,6 +85,18 @@ review apps virtual host configurations.
 - apache
 - podman containers (one per review app)
 
+## Storage
+
+<!-- databases? plain text file? the frigging blockchain? memory? -->
+
+## Queues
+
+<!-- email queues, job queues, schedulers -->
+
+## Interfaces
+
+<!-- e.g. web APIs, commandline clients, etc -->
+
 ## Authentication
 
 The donate-review *runner* uses token authentication to pick up jobs from
@@ -98,6 +114,15 @@ do this is:
 
     podman exec --interactive --tty donate-neo_main poetry run ./manage.py createsuperuser
 
+## Implementation
+
+<!-- programming languages, frameworks, versions, license -->
+
+## Related services
+
+<!-- dependent services (e.g. authenticates against LDAP, or requires -->
+<!-- git pushes)  -->
+
 ## Issues
 
 There is no issue tracker specifically for this the donate-review runner.
@@ -116,6 +141,22 @@ Anyone contributing to [tpo/web/donate-neo][].
 
 [tpo/web/donate-neo]: https://gitlab.torproject.org/tpo/web/donate-neo
 
+## Upstream
+
+<!-- who the upstreams are, if they are still active, -->
+<!-- collaborative, how do we keep up to date, support channels, see -->
+<!-- also the "Issues" section above -->
+
+## Monitoring and metrics
+
+<!-- describe how this service is monitored, how security issues and -->
+<!-- upgrades are tracked, see also "Upgrades" above. -->
+
+## Tests
+
+<!-- how the service can be tested, for example after major changes -->
+<!-- like IP address changes or upgrades. describe CI, test suites, linting -->
+
 ## Logs
 
 The review app logs may be accessed using the `podman logs <container>` command
@@ -126,6 +167,22 @@ as the `gitlab-runner` user.
 This service has no special backup needs. All the donate-neo instances are
 ephemeral, and a new system can be bootstrapped solely from puppet.
 
+## Other documentation
+
+<!-- references to upstream documentation, if relevant -->
+
+# Discussion
+
+<!-- the "discussion" section is where you put any longer conversation -->
+<!-- about the project that you will not need in a casual -->
+<!-- review. history of the project, why it was done the way it was -->
+<!-- (as opposed to how), alternatives, and other proposals are -->
+<!-- relevant here. -->
+
+<!-- this at least partly overlaps with the TPA-RFC process (see -->
+<!-- policy.md), but in general should defer to proposals when -->
+<!-- available -->
+
 ## Overview
 
 donate-review was created as part of tpo/web/donate-neo#6,
@@ -157,3 +214,11 @@ ensure no untrusted party is allowed to gain this privilege.
 The next step here is to make the donate-review service fully generic to allow
 other web projects with special runtime requirements to deploy review apps in
 the same manner.
+
+## Proposed Solution
+
+<!-- Link to RFC -->
+
+## Other alternatives
+
+<!-- include benchmarks and procedure if relevant -->