Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 1 addition & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,11 @@ jobs:
- uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
- uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
- run: just build-ci
- name: Upload release PDF
if: github.event_name == 'release'
run: gh release upload ${{ github.event.release.tag_name }} ./book/pandoc/pdf/architecture-decision-records.pdf
- name: Upload Pages artifact
if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: ./book/html
path: ./public

deploy:
if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
Expand Down
10 changes: 6 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# mdBook build outputs
/book/
/book-temp/
/d2/
# Hugo build outputs
/public/
/resources/_gen/
/.hugo_build.lock
/assets/jsconfig.json
/hugo_stats.json

# Vale style downloads
/.vale/styles/
Expand Down
3 changes: 3 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ dta.gov.au

# CI/build tool sites that timeout
kubectl.docs.kubernetes.io

# New Hugo printable route exists after this branch deploys
adr.dtt.digital.wa.gov.au/printable
2 changes: 1 addition & 1 deletion .rumdl.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# rumdl configuration for ADR project
[global]
exclude = ["SUMMARY.md"]
exclude = ["public", "resources/_gen"]
disable = ["MD013"] # Line length disabled - tables need wide lines
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ These patterns help you build secure, compliant digital services faster. Instead

### Getting Started

1. **Review the [Architecture Principles](architecture-principles.md)** - Six guiding principles for all technology decisions
1. **Review the [Architecture Principles](content/docs/architecture-principles.md)** - Six guiding principles for all technology decisions
2. **Choose a Reference Architecture** - Project kickoff templates combining multiple decisions:
- [Content Management](reference-architectures/content-management.md) - Websites, intranets, and content portals
- [Data Pipelines](reference-architectures/data-pipelines.md) - Analytics, reporting, and data processing
- [Identity Management](reference-architectures/identity-management.md) - User authentication and single sign-on
- [OpenAPI Backends](reference-architectures/openapi-backends.md) - Backend services and integrations
3. **Check the [Compliance Mapping](compliance-mapping.md)** - Find which ADRs apply to your security and compliance requirements
- [Content Management](content/docs/reference-architectures/content-management.md) - Websites, intranets, and content portals
- [Data Pipelines](content/docs/reference-architectures/data-pipelines.md) - Analytics, reporting, and data processing
- [Identity Management](content/docs/reference-architectures/identity-management.md) - User authentication and single sign-on
- [OpenAPI Backends](content/docs/reference-architectures/openapi-backends.md) - Backend services and integrations
3. **Check the [Compliance Mapping](content/docs/compliance-mapping.md)** - Find which ADRs apply to your security and compliance requirements

### Compliance Alignment

Expand All @@ -26,26 +26,26 @@ These ADRs align with:

Supporting training: [DGOV Technical - DevSecOps Induction](https://soc.cyber.wa.gov.au/training/devsecops-induction/)

**[Browse online](https://wagov-dtt.github.io/architecture-decision-records/)** | **[Download PDF](https://wagov-dtt.github.io/architecture-decision-records/architecture-decision-records.pdf)**
**[Browse online](https://adr.dtt.digital.wa.gov.au/)** | **[Printable view](https://adr.dtt.digital.wa.gov.au/printable/)**

---

## Contributing

New ADRs document the **context** (problem), **decision** (solution), and **consequences** (trade-offs). See the [Contributing Guide](CONTRIBUTING.md) for workflow and templates.
New ADRs document the **context** (problem), **decision** (solution), and **consequences** (trade-offs). See the [Contributing Guide](content/docs/contributing.md) for workflow and templates.

For AI-assisted contributions, see the guidance in [CONTRIBUTING.md](CONTRIBUTING.md).
For AI-assisted contributions, see the guidance in [CONTRIBUTING.md](content/docs/contributing.md).

## Repository Structure

This project uses [mdBook](https://rust-lang.github.io/mdBook/) to generate documentation:
This project uses [Hugo](https://gohugo.io/) and [Hinode](https://gethinode.com/) to generate documentation:

- `development/`, `operations/`, `security/` - ADRs by domain
- `reference-architectures/` - Project kickoff templates
- `SUMMARY.md` - Navigation structure
- `content/docs/development/`, `content/docs/operations/`, `content/docs/security/` - ADRs by domain
- `content/docs/reference-architectures/` - Project kickoff templates
- Hugo front matter - Navigation structure

```bash
just setup # One-time tool installation
just serve # Preview locally (port 8080)
just build # Build website and PDF
just build # Build website and printable view
```
56 changes: 0 additions & 56 deletions SUMMARY.md

This file was deleted.

46 changes: 0 additions & 46 deletions book.toml

This file was deleted.

94 changes: 0 additions & 94 deletions compliance-mapping.md

This file was deleted.

6 changes: 6 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "WA Government Architecture Decision Records"
description: "Reusable architecture patterns for WA Government digital services, maintained by the Office of Digital Government (DGOV) Digital Transformation and Technology Unit (DTT)."
weight: 1
toc: true
---
Loading