Skip to content

🎨 Palette: Documentation accessibility scaffolding #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
google-labs-jules wants to merge 1 commit into from
Closed

🎨 Palette: Documentation accessibility scaffolding #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion .template/docs/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Template description for ${title_name}.

1. **AWS Lambda function**: Handles events.

![Architecture diagram](diagrams/${name}.png)
![Architecture diagram for ${title_name} showing the data flow between components](diagrams/${name}.png)

## Code

Expand All @@ -20,3 +20,17 @@ Deploy the stack using:
```bash
make deploy STACK=${name}
```

### Data models

Model | Description
--- | ---
`${camel_name}Model` | Description of the data model

### Environment variables

Variable | Description
--- | ---
`TABLE_NAME` | DynamoDB table name
`SERVICE_NAME` | Powertools service name
`METRICS_NAMESPACE` | Powertools metrics namespace