Documentation Restructure
This commit is contained in:
33
services/index.md
Normal file
33
services/index.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Services
|
||||
## Purpose
|
||||
Deployable services and applications in the lab (auth, email, monitoring, etc).
|
||||
|
||||
## Includes
|
||||
- Service deployments and configs
|
||||
- Dependencies and integrations
|
||||
- Operational notes specific to the service
|
||||
|
||||
## New Document Template
|
||||
````markdown
|
||||
# <Document Title>
|
||||
## Purpose
|
||||
<what this service does and why it exists>
|
||||
|
||||
!!! info "Assumptions"
|
||||
- <platform assumptions>
|
||||
- <dependency assumptions>
|
||||
|
||||
## Dependencies
|
||||
- <required services, ports, DNS, storage>
|
||||
|
||||
## Procedure
|
||||
```sh
|
||||
# Commands or deployment steps
|
||||
```
|
||||
|
||||
## Validation
|
||||
- <command + expected result>
|
||||
|
||||
## Rollback
|
||||
- <how to undo or recover>
|
||||
````
|
||||
Reference in New Issue
Block a user