Skip to content
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.

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

Bootstrap ADR for glvd #67

Merged
merged 1 commit into from
Apr 15, 2024
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
1 change: 1 addition & 0 deletions .adr-dir
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/adr
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This repository on the other hand contains the actual source code of the Securit
Thereby, this repostory contains the following directories:

- `docs/`: This directory contains documentation regarding `glvd`.
- `adr/`: This directory contains ADRs (Architecture Decision Records), as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
- `src/`: This directory contains the source files of `glvd`.
- `glvd/`: The main directory of the Security Tracker.
- `cli/`: Command Line Interface for running operational tasks on `glvd`.
Expand All @@ -34,4 +35,4 @@ The client documentation can be found here: [docs/01_client.md](./docs/01_client
The server documentation can be found here: [docs/02_server.md](./docs/02_server.md)

### Ingestion
The ingestion documentation can be found here: [docs/03_ingestion.md](./docs/03_ingestion.md)
The ingestion documentation can be found here: [docs/03_ingestion.md](./docs/03_ingestion.md)
19 changes: 19 additions & 0 deletions docs/adr/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 1. Record architecture decisions

Date: 2024-04-15

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).