Skip to content

Architecture Decision Records

Architecture Decision Records (ADRs) document the key technical decisions made across the Jersal organization, including the context, options considered, and rationale for the chosen approach.

Index

ADR Title Status Date
ADR-0001 Use Azure as cloud provider Accepted 2024
ADR-0002 Use Terraform for infrastructure as code Accepted 2024
ADR-0003 Use GitHub OIDC for Azure authentication Accepted 2024
ADR-0004 Use a monorepo for core infrastructure Accepted 2024

ADR template

When creating a new ADR, use the following template:

---
tags:
  - adrs
---

# ADR-NNNN: Title

## Status

Proposed | Accepted | Deprecated | Superseded by [ADR-NNNN](link)

## Context

What is the issue that we're seeing that is motivating this decision or change?

## Decision

What is the change that we're proposing and/or doing?

## Consequences

What becomes easier or more difficult to do because of this change?

### Positive

- ...

### Negative

- ...

### Neutral

- ...

Process

  1. Copy the template above into a new file: adrs/NNNN-short-title.md
  2. Fill in the context, decision, and consequences
  3. Add the ADR to the index table above
  4. Add the ADR to the navigation in mkdocs.yml
  5. Submit as a PR for review

Scope

  • Organization-level ADRs live here in the hub (decisions affecting multiple projects or shared infrastructure)
  • Project-level decisions belong in each project's docs/decisions.md file