Skip to content

Commit 4759a34

Browse files
authored
NO-JIRA: chore(docs/adr): begin recording architectural decisions made on this project with the help of adr-tools (#858)
``` $ brew install adr-tools $ adr init docs/architecture/decisions ``` * clarify not-using of opendatahub ADR repository and provide reasoning based on prior experience
1 parent 310b26e commit 4759a34

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

.adr-dir

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/architecture/decisions
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# 1. Record architecture decisions
2+
3+
Date: 2025-01-18
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
We need to record the architectural decisions made on this project.
12+
13+
## Decision
14+
15+
We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
16+
17+
We will presently ignore the [opendatahub-io/architecture-decision-records](https://github.com/opendatahub-io/architecture-decision-records)
18+
repository, since our ADRs are (at least initially) be internal to the notebooks project itself and also because
19+
previous experience ([PR#91](https://github.com/opendatahub-io/architecture-decision-records/pull/91))
20+
shows that it is challenging to get merge approval for a PR there.
21+
22+
## Consequences
23+
24+
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Getting started
2+
3+
* <https://github.com/npryce/adr-tools>, installation:
4+
[Linux](https://github.com/npryce/adr-tools/blob/master/INSTALL.md#from-a-release-package-linux-macos-x),
5+
[Homebrew](https://formulae.brew.sh/formula/adr-tools)
6+
7+
```commandline
8+
brew install adr-tools
9+
```
10+
11+
## Start new ADR
12+
13+
<https://github.com/npryce/adr-tools?tab=readme-ov-file#quick-start>
14+
15+
```commandline
16+
adr new Implement as Unix shell scripts
17+
```
18+
19+
## Initialize new ADR directory
20+
21+
```commandline
22+
adr init docs/architecture/decisions
23+
```
24+
25+
## OpenDataHub ADRs
26+
27+
<https://github.com/opendatahub-io/architecture-decision-records>

0 commit comments

Comments
 (0)