Skip to content

Commit 096c3ec

Browse files
committed
docs: introduce copy edits suggested in code review
1 parent 2b75599 commit 096c3ec

5 files changed

Lines changed: 14 additions & 33 deletions

File tree

docs/explanation/deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deployment
22

3-
The Benefits app is currently deployed into a Microsoft Azure account provided by [California Department of Technology (CDT)'s Office of Enterprise Technology (OET)][oet], a.k.a. the "DevSecOps" team. More specifically, [Azure Container Apps][container-apps]. [More about the infrastructure.](infrastructure.md)
3+
The Benefits app is currently deployed into a Microsoft Azure account provided by [California Department of Technology (CDT)'s Office of Enterprise Technology (OET)][oet], a.k.a. the "DevSecOps" team. More specifically, it uses [Azure Container Apps][container-apps]. [More about the infrastructure.](infrastructure.md)
44

55
## Deployment process
66

docs/explanation/infrastructure.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -121,22 +121,23 @@ The DevSecOps team sets the following naming convention for Resources:
121121
### Sample Names
122122

123123
- `RG-CDT-PUB-VIP-BNSCN-E-D-001`
124-
- `ASP-CDT-PUB-VIP-BNSCN-EL-P-001`
125-
- `AS-CDT-PUB-VIP-BNSCN-EL-D-001`
124+
- `CAE-CDT-PUB-VIP-BNSCN-EL-P-001`
125+
- `CA-CDT-PUB-VIP-BNSCN-EL-D-001`
126126

127127
### Resource Types
128128

129129
Use the following shorthand for conveying the Resource Type as part of the Resource Name:
130130

131-
| Resource | Convention |
132-
| --------------- | ---------- |
133-
| Container App | `CA` |
134-
| Virtual Network | `VNET` |
135-
| Resource Group | `RG` |
136-
| Virtual Machine | `VM` |
137-
| Database | `DB` |
138-
| Subnet | `SNET` |
139-
| Front Door | `FD` |
131+
| Resource | Convention |
132+
| -------------------------- | ---------- |
133+
| Container Apps Environment | `CAE` |
134+
| Container App | `CA` |
135+
| Virtual Network | `VNET` |
136+
| Resource Group | `RG` |
137+
| Virtual Machine | `VM` |
138+
| Database | `DB` |
139+
| Subnet | `SNET` |
140+
| Front Door | `FD` |
140141

141142
## Making changes
142143

docs/guides/troubleshooting.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,7 @@ We have [ping tests](https://docs.microsoft.com/en-us/azure/azure-monitor/app/mo
1010

1111
#### Azure Container App Logs
1212

13-
[Open the `Logs` for the environment you are interested in.](https://docs.google.com/document/d/11EPDIROBvg7cRtU2V42c6VBxcW_o8HhcyORALNtL_XY/edit#heading=h.6pxjhslhxwvj) The following tables are likely of interest:
14-
15-
- `AppServiceConsoleLogs`: `stdout` and `stderr` coming from the container
16-
- `AppServiceHTTPLogs`: requests coming through Container App
17-
- `AppServicePlatformLogs`: deployment information
13+
In the Azure Portal, in the Container App, you can find real time logs under Monitoring > Log stream and historical logs under Monitoring > Logs
1814

1915
For some pre-defined queries, click `Queries`, then `Group by: Query type`, and look under `Query pack queries`.
2016

docs/reference/environment-variables.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -184,21 +184,6 @@ Comma-separated list of User-Agent strings which, when present as an HTTP header
184184

185185
## Django database
186186

187-
### `USE_POSTGRES`
188-
189-
!!! tldr "Django docs"
190-
191-
[Settings: `DATABASES`](https://docs.djangoproject.com/en/6.0/ref/settings/#databases)
192-
193-
Feature flag to enable using Postgres as the database.
194-
195-
Boolean:
196-
197-
- `true`: the `DATABASES` Django setting is configured to use Postgres (see [`Django database (Postgres)`](#django-database-postgresql))
198-
- `false` (default): the `DATABASES` Django setting is configured to use SQLite (see [`Django database (SQLite)`](#django-database-sqlite))
199-
200-
## Django database (PostgreSQL)
201-
202187
### `DJANGO_DB_NAME`
203188

204189
The name of the database to use for Django.

terraform/modules/application/locals.tf

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ locals {
4242
# Django settings
4343
"DJANGO_STORAGE_DIR" = local.django_storage_dir_path,
4444
# Database settings
45-
"USE_POSTGRES" = "true",
4645
"POSTGRES_HOSTNAME" = var.postgres_fqdn,
4746
"POSTGRES_DB" = var.postgres_admin_db,
4847
"POSTGRES_USER" = var.postgres_admin_login,

0 commit comments

Comments
 (0)