diff --git a/docs/services/service-template.md b/docs/services/service-template.md index 9417bbe870296dc3904d83106c8a73a392c4a2de..9a0edf207bbe8a742a1f2250eab96d8ede5c17aa 100644 --- a/docs/services/service-template.md +++ b/docs/services/service-template.md @@ -34,7 +34,7 @@ The `<service_name>` is currently deployed to the following environments: `<notes about access to environments and anything special about how an environment is used>` -## Source code +## Source Code The source code for the `<service_name>` is spread over the following repositories: @@ -43,7 +43,7 @@ The source code for the `<service_name>` is spread over the following repositori | [Application Server](https://gitlab.developers.cam.ac.uk/uis/devops/EXAMPLE/) | The source code for the main application server | | [Infrastructure Deployment](https://gitlab.developers.cam.ac.uk/uis/devops/EXAMPLE/) | The Terraform infrastructure code for deploying the application server to GCP | -## Technologies used +## Technologies Used The following gives an overview of the technologies the `<service_name>` is built on. @@ -53,17 +53,13 @@ The following gives an overview of the technologies the `<service_name>` is buil | Client | {name and version} | {name and version} | | {other} | {name and version} | {name and version} | -## Operational documentation +## Operational Documentation The following gives an overview of how the `<service_name>` is deployed and maintained. -### How and where the `<service_name>` is deployed +### Deployment -`<documentation or links to external docs describing how and where the application is deployed>` - -### Deploying a new release - -`<documentation or links to external docs about how a new release is made and deployed>` +`<documentation or links to external docs about how a new release is deployed>` ### Monitoring @@ -77,16 +73,10 @@ The following gives an overview of how the `<service_name>` is deployed and main `<documentation or links to external docs about other operation issues>` -## Service Management and tech lead +## Service Management The **service owner** for the `<service_name>` is `<service owner name and Lookup link>`. The **service manager** for the `<service_name>` is `<service manager name and Lookup link>`. The **tech lead** for the `<service_name>` is `<tech lead name and Lookup link>`. - -The following engineers have operational experience with the `<service_name>` and are able to -respond to support requests or incidents: - -* `<engineer name and Lookup link>` -* `<engineer name and Lookup link>`