docs: added docs
This commit is contained in:
@@ -2,6 +2,36 @@
|
||||
|
||||
Service for managing A/B testing experiments. Drive your tests without breaking user experience!_)
|
||||
|
||||
## 🎨 Artifacts
|
||||
|
||||
### Runbook
|
||||
|
||||
[RUNBOOK.md](./RUNBOOK.md)
|
||||
|
||||
### Diagrams
|
||||
|
||||
### Testing report
|
||||
|
||||
Can be seen in GitLab CI/CD pipeline run
|
||||
|
||||
1. Go to the [pipelines page](https://gitlab.prodcontest.com/2026-final-users/backend/itq.dev/-/pipelines)
|
||||
2. Click on the latest pipeline run
|
||||

|
||||
3. Testing report (`Tests` tab)
|
||||

|
||||
4. Tests coverage (`Jobs` tab)
|
||||

|
||||
|
||||
Here on screenshot you can see coverage percent (`97%`), for detailed coverage per file go to the `test` job log
|
||||
|
||||

|
||||
|
||||
### Repository map
|
||||
|
||||
[MAP.md](./MAP.md)
|
||||
|
||||
Yep, artifacts content is written in Russian, but all other docs are in English, this is for judges' convenient experience.
|
||||
|
||||
## 📋 Instructions
|
||||
|
||||
### Dedicated services setup
|
||||
@@ -52,6 +82,26 @@ docker compose -f compose.prod.yaml up
|
||||
|
||||
Thats it, project is already preconfigured for running, so no changes before running this are required.
|
||||
|
||||
## Linting and formatting
|
||||
## Linting && formatting
|
||||
|
||||
Described [here](./src/backend/README.md#)
|
||||
Instructions [here](./src/backend/README.md#linting--formatting).
|
||||
|
||||
Example run:
|
||||

|
||||
|
||||
## Observability
|
||||
|
||||
### Structured logs
|
||||
|
||||

|
||||
|
||||
### Health/ready endpoints (`/health`/`/ready`)
|
||||
|
||||

|
||||

|
||||
|
||||
### Metrics (`/metrics`)
|
||||
|
||||

|
||||
|
||||
System metrics (gc, requests, etc.) and several business metrics (`lotty_decide_requests_total`, `lotty_events_ingested_total"`).
|
||||
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user