-
Notifications
You must be signed in to change notification settings - Fork 7
Added ADRs 008, 009 #253
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
Merged
Merged
Added ADRs 008, 009 #253
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
4744b2a
4565: Added ADRs 008, 009
tuj 62532dc
Update docs/adr/009-remove-remote-components.md
tuj 232c067
4565: Fixed issues raised in review
tuj ed8299d
4565: Fixed markdown issues
tuj fd06733
Update docs/adr/008-mono-repository.md
tuj 7e84877
Update docs/adr/008-mono-repository.md
tuj ff33c3b
4565: Applied coding standards
tuj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# ADR 008 - Mono repository | ||
|
||
Date: 30-06-2025 | ||
|
||
## Status | ||
|
||
Proposed | ||
|
||
## Context | ||
|
||
With the current multi-repository setup, when a new feature is added to the system, it often depends on changes to | ||
multiple repositories, at the same time. | ||
This split across the repositories complicates the development process. | ||
|
||
Another part of this is dependency management and maintenance across multiple repositories. It is important that the | ||
code uses up-to-date dependencies. At the moment, this is especially an issue in the admin, client and templates | ||
repositories that all depend on React and other javascript libraries. By merging these repositories the process of | ||
updating the dependencies will be handled once instead of 3 times. | ||
|
||
## Decision | ||
|
||
We gather the code in `os2display/display-api-service` repository. The `os2display/display-client`, | ||
`os2display/display-admin-client` and `os2display/display-templates` repositories will be merged into | ||
`os2display/display-api-service`. | ||
|
||
The `os2display/display-api-service` repository will be renamed to `os2display/display`. | ||
|
||
The `os2display/display-docs` repository will be kept separate so the user facing documentation can be updated outside | ||
the regular release cycle. | ||
|
||
Symfony routes and controllers will be added for `/client` and `/admin` to handle serving and configuring the screen and | ||
admin clients. This will enable us to move configuration for the two clients to .env and expose directly in html through | ||
twig templates. | ||
|
||
The static javascript build files will be served directly by nginx from `/public`. | ||
|
||
## Consequences | ||
|
||
All the code will be gathered into one repository. This will result in a single point of entry for development. | ||
|
||
Maintaining the javascript parts of the code will be unified. This will make the upgrading tasks easier. | ||
|
||
By unifying the code, features can be gathered into one feature branch. | ||
This will make it easier to track the changes. | ||
|
||
Releases will only involve one tag, instead of multiple tags across repositories. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# ADR 009 - Remove remote components | ||
|
||
Date: 30-06-2025 | ||
|
||
## Status | ||
|
||
Proposed | ||
|
||
## Context | ||
|
||
The [library](https://www.npmjs.com/package/@paciolan/remote-component) for loading remote components we use for | ||
importing the templates is abandoned. | ||
|
||
This makes it harder to keep the React applications up-to-date. Furthermore, remote-components have added | ||
an unfortunate layer that hides javascript errors from the templates. This makes it harder to debug template issues. | ||
|
||
## Decision | ||
|
||
We remove the option of loading external templates into the system (remote components) and replace it with templates | ||
that are a part of the code. The `os2display/display-templates` will be merged with the`os2display/display-api-service` | ||
repository (See ADR-008). | ||
|
||
## Consequences | ||
|
||
Removing remote components will remove the option of importing templates from other locations. Therefore, the templates | ||
need to be a part of the repository code. | ||
|
||
To add your own templates you will have to fork the repository, add your templates and build your own clients. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.