Skip to content

Commit 3778212

Browse files
committed
6871: Added infrastructure documentation
1 parent addb807 commit 3778212

2 files changed

Lines changed: 31 additions & 17 deletions

File tree

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,24 @@
99
5. [Taskfile](#taskfile)
1010
6. [Development setup](#development-setup)
1111
7. [Production setup](#production-setup)
12-
8. [Coding standards](#coding-standards)
13-
9. [Stateless](#stateless)
14-
10. [OIDC providers](#oidc-providers)
15-
11. [JWT Auth](#jwt-auth)
16-
12. [Test](#test)
17-
13. [API specification and generated code](#api-specification-and-generated-code)
18-
14. [Configuration](#configuration)
19-
15. [Rest API & Relationships](#rest-api--relationships)
20-
16. [Error codes in the Client](#error-codes-in-the-client)
21-
17. [Preview mode in the Client](#preview-mode-in-the-client)
22-
18. [Feeds](#feeds)
23-
19. [Custom Templates](#custom-templates)
24-
20. [Static Analysis](#static-analysis)
25-
21. [Upgrade Guide](#upgrade-guide)
26-
22. [Tenants](#tenants)
27-
23. [Screen layouts](#screen-layouts)
28-
24. [Templates](#templates)
12+
8. [Infrastructure](#infrastructure)
13+
9. [Coding standards](#coding-standards)
14+
10. [Stateless](#stateless)
15+
11. [OIDC providers](#oidc-providers)
16+
12. [JWT Auth](#jwt-auth)
17+
13. [Test](#test)
18+
14. [API specification and generated code](#api-specification-and-generated-code)
19+
15. [Configuration](#configuration)
20+
16. [Rest API & Relationships](#rest-api--relationships)
21+
17. [Error codes in the Client](#error-codes-in-the-client)
22+
18. [Preview mode in the Client](#preview-mode-in-the-client)
23+
19. [Feeds](#feeds)
24+
20. [Custom Templates](#custom-templates)
25+
21. [Static Analysis](#static-analysis)
26+
22. [Upgrade Guide](#upgrade-guide)
27+
23. [Tenants](#tenants)
28+
24. [Screen layouts](#screen-layouts)
29+
25. [Templates](#templates)
2930

3031
## Description
3132

@@ -163,6 +164,19 @@ Use the `app:update` command to migrate and update templates to latest version:
163164
docker compose exec phpfpm bin/console app:update --no-interaction
164165
```
165166

167+
## Infrastructure
168+
169+
When a new tag is created a GitHub release is created with built assets.
170+
171+
After this, docker images are built and published in GitHub packages:
172+
<https://github.com/orgs/os2display/packages?repo_name=display-api-service>
173+
174+
See <https://github.com/itk-dev/os2display-docker-server-v3> for a docker based server setup, that uses these packages.
175+
176+
TODO: Fix links after repository moves and renames.
177+
178+
![Infrastructure overview](docs/infrastructure.png)
179+
166180
## Coding standards
167181

168182
Before a PR can be merged it has to pass the GitHub Actions checks. See `.github/workflows` for workflows that should

docs/infrastructure.png

154 KB
Loading

0 commit comments

Comments
 (0)