Skip to content

Commit 8be3f8e

Browse files
author
Anna Mikhaylova
committed
Merge branch 'feature/mddocs-en-folder' of https://github.com/MTSWebServices/syncmaster into feature/mddocs-en-folder
2 parents a33c9d3 + b03b6a2 commit 8be3f8e

10 files changed

Lines changed: 30 additions & 28 deletions

File tree

mddocs/changelog/0.2.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- Completely new UI.
66
- Add support for FileSystem connections.
7-
- Add support for simple tranformations within transfer - filter files, filter rows, change columns.
7+
- Add support for simple transformations within transfer - filter files, filter rows, change columns.
88
- Add support for incremental read strategy.
99
- Add support for running transfers by schedule.
1010
- Add support for changing SparkSession resource limits.
@@ -60,7 +60,7 @@ Huge thanks to [Dmitry Pedchenko](https://github.com/dmitry-pedchenko), [Maxim L
6060

6161
## Bug Fixes
6262

63-
- Use Hadoop AWS `magic` commiter only if transfer *target* is S3. ([#46](https://github.com/MobileTeleSystems/syncmaster/issues/46))
63+
- Use Hadoop AWS `magic` committer only if transfer *target* is S3. ([#46](https://github.com/MobileTeleSystems/syncmaster/issues/46))
6464
- Check that `service_name` and `sid` are mutually exclusive when editing Oracle connection. ([#52](https://github.com/MobileTeleSystems/syncmaster/issues/52))
6565
- Queue name is unique within a group, new field `slug` is globally-unique. ([#54](https://github.com/MobileTeleSystems/syncmaster/issues/54), [#119](https://github.com/MobileTeleSystems/syncmaster/issues/119))
6666
- Prohibit updating connection type it if there is a transfer associated with this connection. ([#55](https://github.com/MobileTeleSystems/syncmaster/issues/55))

mddocs/changelog/0.2.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414

1515
## Bug fixes
1616

17-
- Call `kinit` before starting Spark session conecting to `Hive` cluster. ([#225](https://github.com/MobileTeleSystems/syncmaster/issues/225))
17+
- Call `kinit` before starting Spark session connecting to `Hive` cluster. ([#225](https://github.com/MobileTeleSystems/syncmaster/issues/225))
1818
- Fix `HDFS` connection was trying to use anonymous auth instead of user/password. ([#225](https://github.com/MobileTeleSystems/syncmaster/issues/225))
1919
- Fix updating queue ignored name and didn’t reset description.

mddocs/changelog/0.3.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ auth:
6363
### Example config.yml
6464

6565
```yaml
66-
config.yml:
66+
config.yml:
6767
worker:
6868
spark_session_default_config:
6969
spark.master: local

mddocs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# SPDX-FileCopyrightText: 2025-present MTS PJSC
2+
# SPDX-License-Identifier: Apache-2.0
13
# SPDX-FileCopyrightText: 2023-2024 MTS PJSC
24
# SPDX-License-Identifier: Apache-2.0
35
# Configuration file for the Sphinx documentation builder.

mddocs/design/entities/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Groups are independent from each other, and have globally unique name.
1717
![image](group_info.png)
1818

1919
Group can be created by any user, which automatically get `OWNER` role.
20-
This role allows adding members to the group, and assign them speficic roles:
20+
This role allows adding members to the group, and assign them specific roles:
2121

2222
![image](group_add_member.png)
2323

@@ -77,7 +77,7 @@ title: Entity Diagram
7777
erDiagram
7878
direction LR
7979
User {
80-
number id
80+
number id
8181
string username
8282
string is_active
8383
string is_superuser
@@ -86,7 +86,7 @@ erDiagram
8686
}
8787
8888
Group {
89-
number id
89+
number id
9090
string name
9191
string description
9292
number owner_id
@@ -95,7 +95,7 @@ erDiagram
9595
}
9696
9797
Connection {
98-
number id
98+
number id
9999
number group_id
100100
string type
101101
string name
@@ -106,17 +106,17 @@ erDiagram
106106
}
107107
108108
Queue {
109-
number id
109+
number id
110110
string name
111111
string slug
112112
string description
113113
string created_at
114114
string updated_at
115115
}
116-
116+
117117
118118
Transfer {
119-
number id
119+
number id
120120
number group_id
121121
string name
122122
number source_connection_id
@@ -144,9 +144,9 @@ erDiagram
144144
string created_at
145145
string updated_at
146146
}
147-
148-
Run ||--o{ Transfer: contains
149-
147+
148+
Run ||--o{ Transfer: contains
149+
150150
Transfer ||--o{ Queue: contains
151151
Transfer ||--o{ Connection: contains
152152
Transfer ||--o{ Group: contains

mddocs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## What is Data.SyncMaster?
77

8-
Data.SyncMaster is as low-code ETL tool for transfering data between databases and file systems.
8+
Data.SyncMaster is as low-code ETL tool for transferring data between databases and file systems.
99
List of currently supported connections:
1010

1111
* Apache Hive
@@ -28,7 +28,7 @@ Based on [onETL](https://onetl.readthedocs.io/) and [Apache Spark](https://spark
2828

2929
## Goals
3030

31-
* Make transfering data between databases and file systems as simple as possible
31+
* Make transferring data between databases and file systems as simple as possible
3232
* Provide a lot of builtin connectors to transfer data in heterogeneous environment
3333
* RBAC and multitenancy support
3434

mddocs/reference/database/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ For non-empty database, it will perform database structure upgrade, using [Alemb
248248
- Create virtual environment
249249

250250
```console
251-
$ python -m venv /some/.venv
251+
$ python -m venv /some/.venv
252252
$ source /some/.venv/activate
253253
...
254254
```

mddocs/reference/database/structure.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ erDiagram
1111
User_Group {
1212
bigint user_id PK
1313
bigint group_id PK
14-
varchar(255) role_id
14+
varchar(255) role_id
1515
}
1616
1717
User {
18-
bigint id PK
19-
varchar(256) username
20-
varchar(256) email null
18+
bigint id PK
19+
varchar(256) username
20+
varchar(256) email null
2121
varchar(256) first_name null
2222
varchar(256) last_name null
2323
varchar(256) middle_name null
@@ -29,10 +29,10 @@ erDiagram
2929
3030
Group {
3131
bigint id PK
32-
varchar(256) name
32+
varchar(256) name
3333
varchar(512) description
3434
bigint owner_id
35-
timestamptz created_at
35+
timestamptz created_at
3636
timestamptz updated_at
3737
tsquery search_vector
3838
}
@@ -49,12 +49,12 @@ erDiagram
4949
5050
Connection {
5151
bigint id PK
52-
bigint group_id
52+
bigint group_id
5353
varchar(32) type
54-
varchar(123) name
54+
varchar(123) name
5555
varchar(512) description
5656
json data
57-
timestamptz created_at
57+
timestamptz created_at
5858
timestamptz updated_at
5959
tsquery search_vector
6060
}

mddocs/reference/frontend/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Frontend { #frontend }
22

33
SyncMaster provides a [Frontend (UI)](https://github.com/MobileTeleSystems/syncmaster-ui) based on [React](https://react.dev/),
4-
providing users the ability to create, update, delete entitities.
4+
providing users the ability to create, update, delete entities.
55

66
## Install & run
77

mddocs/reference/worker/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ For example, for slug `123-test_queue` this should be `-Q 123-test_queue`.
291291
Refer to the [Celery](https://docs.celeryq.dev/en/stable/) documentation for more advanced start options.
292292

293293
> **`--max-tasks-per-child=1` flag is important!**
294-
294+
295295
## See also
296296

297297
- [Configuration][worker-configuration]

0 commit comments

Comments
 (0)