Skip to content

Commit

Permalink
2770: Fixed issues from review
Browse files Browse the repository at this point in the history
  • Loading branch information
tuj committed Nov 28, 2024
1 parent 6f6541c commit d9c0fd2
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
10 changes: 8 additions & 2 deletions docs/adr/001-record-architectural-decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,17 @@ We need to record the architectural decisions made on this project. Architectura
[described by Michael Nygard](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) provides a
framework for writing down these decisions.

The project has been running for several years and there is a need for summarizing some of the baselines of the project,
to document the original ideas and decisions.

## Decision

We will use Architectural Decision Records.

We will write down the original architectural decisions as ADRs even though years have passed, to help document the
thoughts behind the project.

## Consequences

Introduces an additional burden on core project maintainers to diligently follow architecture discussions and record the
results in this repo as an ADR.
This introduces an additional burden on core project maintainers to diligently follow architecture discussions and
record the decisions in this repo as an ADR.
3 changes: 2 additions & 1 deletion docs/adr/002-api-first.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ See more about the "API first" approach [here](https://swagger.io/resources/arti
The previous version of OS2Display was used without the admin module in some contexts.
We want to support other uses than the standard OS2Display setup.

By adopting the API first approach it will be possible to replace clients without rewriting the entire application.
By adopting the API first approach it will be possible to replace or write other clients without rewriting the entire
application. E.g. an external system could create content through calls to the API.
This will make the system more future-proof.

[OpenAPI](https://www.openapis.org/) is a standard for describing an API interface.
Expand Down
3 changes: 2 additions & 1 deletion docs/adr/004-browser-based-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ By being contained in a browser of the client machine we are limited in what we

The browser sets sandboxing constraints on the application when running in a browser.

The benefit is that that client should be able to run on most environments.
The benefit is that that client should be able to run on most environments and most people know how to set up a screen
in a browser.
2 changes: 1 addition & 1 deletion docs/adr/007-configurability.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ We will make features configurable through environment and config files.
## Consequences

Features that are not "core" will have to be implemented as configurable wherever possible.
This will introduce extra work when implementing features.
This will introduce extra work when implementing features and increase the complexity of the application code.

0 comments on commit d9c0fd2

Please sign in to comment.