Skip to content

Commit 31c350a

Browse files
author
Anna Mikhaylova
committed
[DOP-27545] fix mistakes for review
1 parent c07727d commit 31c350a

16 files changed

Lines changed: 93 additions & 446 deletions

File tree

‎mddocs/docs/en/changelog/DRAFT.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
11
# DRAFT { #DRAFT }
2-
3-
```{eval-rst}
4-
.. towncrier-draft-entries:: |release| [UNRELEASED]
5-
```

‎mddocs/docs/en/contributing.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,11 +152,10 @@ make test-check-fixtures
152152

153153
#### Integration tests
154154

155-
#### WARNING
155+
!!! warning
156+
To run HDFS and Hive tests locally you should add the following line to your `/etc/hosts` (file path depends on OS):
156157

157-
To run HDFS and Hive tests locally you should add the following line to your `/etc/hosts` (file path depends on OS):
158-
159-
```default
158+
```
160159
# HDFS/Hive server returns container hostname as connection address, causing error in DNS resolution
161160
127.0.0.1 test-hive
162161
```

‎mddocs/docs/en/design/entities/index.md‎

Lines changed: 50 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -70,173 +70,79 @@ Transfers cannot be created without queue. If there are no workers bound to a qu
7070

7171
## Entity Diagram
7272

73-
```plantuml
74-
75-
@startuml
76-
title Entity Diagram
77-
78-
left to right direction
79-
80-
entity User {
81-
* id
82-
----
83-
username
84-
is_active
85-
is_superuser
86-
created_at
87-
updated_at
88-
}
89-
90-
entity Group {
91-
* id
92-
----
93-
name
94-
description
95-
owner_id
96-
created_at
97-
updated_at
98-
}
99-
100-
entity Connection {
101-
* id
102-
----
103-
group_id
104-
type
105-
name
106-
description
107-
data
108-
created_at
109-
updated_at
110-
}
111-
112-
entity Queue {
113-
* id
114-
----
115-
name
116-
slug
117-
group_id
118-
description
119-
created_at
120-
updated_at
121-
}
122-
123-
entity Transfer {
124-
* id
125-
----
126-
group_id
127-
name
128-
source_connection_id
129-
target_connection_id
130-
strategy_params
131-
target_params
132-
transformations
133-
resources
134-
is_scheduled
135-
schedule
136-
queue_id
137-
created_at
138-
updated_at
139-
}
140-
141-
entity Run {
142-
* id
143-
----
144-
transfer_id
145-
started_at
146-
ended_at
147-
status
148-
type
149-
log_url
150-
transfer_dump
151-
created_at
152-
updated_at
153-
}
154-
155-
Run ||--o{ Transfer
156-
Transfer ||--o{ Queue
157-
Transfer ||--o{ Connection
158-
Transfer ||--o{ Group
159-
Connection ||--o{ Group
160-
Queue ||--o{ Group
161-
Group }o--o{ User
162-
Group "owner_id" ||--o{ User
163-
164-
@enduml
165-
```
166-
16773
```mermaid
16874
---
16975
title: Entity Diagram
17076
---
17177
erDiagram
17278
direction LR
17379
User {
174-
id
175-
username
176-
is_active
177-
is_superuser
178-
created_at
179-
updated_at
80+
number id
81+
string username
82+
string is_active
83+
string is_superuser
84+
string created_at
85+
string updated_at
18086
}
18187
18288
Group {
183-
id
184-
name
185-
description
186-
owner_id
187-
created_at
188-
updated_at
89+
number id
90+
string name
91+
string description
92+
number owner_id
93+
string created_at
94+
string updated_at
18995
}
19096
19197
Connection {
192-
id
193-
group_id
194-
type
195-
name
196-
description
197-
data
198-
created_at
199-
updated_at
98+
number id
99+
number group_id
100+
string type
101+
string name
102+
string description
103+
string data
104+
string created_at
105+
string updated_at
200106
}
201107
202108
Queue {
203-
id
204-
name
205-
slug
206-
description
207-
created_at
208-
updated_at
109+
number id
110+
string name
111+
string slug
112+
string description
113+
string created_at
114+
string updated_at
209115
}
210116
211117
212118
Transfer {
213-
id
214-
group_id
215-
name
216-
source_connection_id
217-
target_connection_id
218-
strategy_params
219-
target_params
220-
transformations
221-
resources
222-
is_scheduled
223-
schedule
224-
queue_id
225-
created_at
226-
updated_at
119+
number id
120+
number group_id
121+
string name
122+
number source_connection_id
123+
number target_connection_id
124+
string strategy_params
125+
string target_params
126+
string transformations
127+
string resources
128+
string is_scheduled
129+
string schedule
130+
number queue_id
131+
string created_at
132+
string updated_at
227133
}
228134
229135
Run {
230-
id
231-
transfer_id
232-
started_at
233-
ended_at
234-
status
235-
type
236-
log_url
237-
transfer_dump
238-
created_at
239-
updated_at
136+
number id
137+
number transfer_id
138+
string started_at
139+
string ended_at
140+
string status
141+
string type
142+
string log_url
143+
string transfer_dump
144+
string created_at
145+
string updated_at
240146
}
241147
242148
Run ||--o{ Transfer: contains

‎mddocs/docs/en/reference/broker/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ But the only broker we tested is [RabbitMQ](https://www.rabbitmq.com/).
3131

3232
### `docker-compose.yml`
3333

34-
```default
34+
```
3535
services:
3636
db:
3737
image: postgres:17
@@ -168,7 +168,7 @@ But the only broker we tested is [RabbitMQ](https://www.rabbitmq.com/).
168168

169169
### `.env.docker`
170170

171-
```default
171+
```
172172
TZ=UTC
173173
ENV=LOCAL
174174

‎mddocs/docs/en/reference/database/index.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ After a database is started, it is required to run migration script.
1010
For empty database, it creates all the required tables and indexes.
1111
For non-empty database, it will perform database structure upgrade, using [Alembic](https://alembic.sqlalchemy.org/).
1212

13-
### WARNING
14-
15-
Other containers (server, scheduler, worker) should be stopped while running migrations, to prevent interference.
13+
!!! warning
14+
Other containers (server, scheduler, worker) should be stopped while running migrations, to prevent interference.
1615

1716
## Requirements
1817

@@ -42,7 +41,7 @@ Other containers (server, scheduler, worker) should be stopped while running mig
4241

4342
### `docker-compose.yml`
4443

45-
```default
44+
```
4645
services:
4746
db:
4847
image: postgres:17
@@ -179,7 +178,7 @@ Other containers (server, scheduler, worker) should be stopped while running mig
179178

180179
### `.env.docker`
181180

182-
```default
181+
```
183182
TZ=UTC
184183
ENV=LOCAL
185184

0 commit comments

Comments
 (0)