Skip to content

Commit afe9614

Browse files
author
Anna Mikhaylova
committed
[DOP-27545] fix title
1 parent 04c7f04 commit afe9614

7 files changed

Lines changed: 35 additions & 37 deletions

File tree

mddocs/changelog.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
11
# Changelog { #changelog }
22

3-
- [0.3.3 [UNRELEASED] (2025-09-30)][DRAFT]
4-
- [0.3.2 (2026-03-05)][0.3.2]
5-
- [0.3.1 (2026-01-15)][0.3.1]
6-
- [0.3.0 (2025-12-18)][0.3.0]
7-
- [0.2.5 (2025-10-10)][0.2.5]
8-
- [0.2.4 (2025-07-09)][0.2.4]
9-
- [0.2.3 (2025-04-11)][0.2.3]
10-
- [0.2.2 (2025-04-11)][0.2.2]
11-
- [0.2.1 (2025-04-07)][0.2.1]
12-
- [0.2.0 (2025-04-04)][0.2.0]
13-
- [0.1.5 (2024-04-22)][0.1.5]
14-
- [0.1.4 (2024-04-15)][0.1.4]
15-
- [0.1.3 (2024-04-15)][0.1.3]
16-
- [0.1.2 (2024-04-15)][0.1.2]
17-
- [0.1.1 (2024-03-29)][0.1.1]
3+
!include(../../changelog/index.md)

mddocs/changelog/0.3.0.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ auth:
6262

6363
### Example config.yml
6464

65-
```yaml
66-
config.yml:
65+
```yaml title="config.yml"
6766
worker:
6867
spark_session_default_config:
6968
spark.master: local

mddocs/reference/frontend/configuration.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
## API url
44

5-
SyncMaster UI requires REST API to be accessible from browser. API url is set up using environment variable:
5+
SyncMaster UI requires REST API to be accessible from browser. API url is set up using config file:
66

7-
```bash
8-
SYNCMASTER__UI__API_BROWSER_URL=http://localhost:8000
7+
```yaml title="config.yml"
8+
ui:
9+
api_browser_url: http://localhost:8000
910
```
1011
1112
If both REST API and frontend are served on the same domain (e.g. through Nginx reverse proxy), for example:
@@ -15,6 +16,18 @@ If both REST API and frontend are served on the same domain (e.g. through Nginx
1516

1617
Then you can use relative path:
1718

18-
```bash
19-
SYNCMASTER__UI__API_BROWSER_URL=/api
19+
```yaml title="config.yml"
20+
ui:
21+
api_browser_url: /api
22+
```
23+
24+
## Auth provider
25+
26+
By default, SyncMaster UI shows login page with username & password fields, designed for [server-auth-dummy][server-auth-dummy].
27+
To show a login page for [keycloak-auth-provider][keycloak-auth-provider], you should set config option:
28+
29+
```yaml title="config.yml"
30+
ui:
31+
auth_provider: keycloakAuthProvider
32+
# auth_provider: dummyAuthProvider
2033
```

mddocs/reference/server/configuration/debug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This is done by adding a specific filter to logging settings:
5454

5555
### `config.yml`
5656

57-
```yaml
57+
```yaml title="config.yml"
5858
logging:
5959
filters:
6060
correlation_id:

mddocs/reference/server/manage_superusers_cli.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ There are two ways to manage users:
99

1010
Usernames can be passed via config file:
1111

12-
```yaml title="config.yml"
13-
superusers:
14-
- user1
15-
- user2
16-
```
12+
```yaml title="config.yml"
13+
superusers:
14+
- user1
15+
- user2
16+
```
1717
1818
Or via environment variable:
1919
20-
```bash
21-
export 'SYNCMASTER__SUPERUSERS=["user1", "user2"]'
22-
```
20+
```bash
21+
export 'SYNCMASTER__SUPERUSERS=["user1", "user2"]'
22+
```
2323

2424
- manual via CLI:
2525
<!-- TODO: fix docstring extraction -->

mddocs/reference/worker/create_spark_session.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ By default, SparkSession is created with ``spark.master: local``, including all
88

99
It is possible to alter default [Spark Session configuration](https://spark.apache.org/docs/latest/configuration.html)_ worker settings:
1010

11-
```yaml
11+
```yaml title="config.yaml"
1212
worker:
1313
spark_session_default_config:
1414
spark.master: local
@@ -20,7 +20,7 @@ worker:
2020
2121
For example, to use SyncMaster on Spark-on-K8s, you can use worker image for Spark executor containers:
2222
23-
```yaml
23+
```yaml title="config.yaml"
2424
worker:
2525
spark_session_default_config:
2626
spark.master: k8s://https://kubernetes.default.svc
@@ -41,7 +41,7 @@ worker:
4141
4242
It is also possible to use custom function which returns ``SparkSession`` object:
4343
44-
```yaml
44+
```yaml title="config.yaml"
4545
worker:
4646
create_spark_session_function: my_worker.spark.create_custom_spark_session
4747
```
@@ -60,8 +60,8 @@ def create_custom_spark_session(
6060
target: ConnectionDTO,
6161
settings: WorkerSettings,
6262
) -> SparkSession:
63-
# any custom code returning SparkSession object
64-
return SparkSession.builde.config(...).getOrCreate()
63+
# any custom code returning SparkSession object
64+
return SparkSession.builde.config(...).getOrCreate()
6565
```
6666

6767
Module with custom function should be placed into the same Docker image or Python virtual environment used by SyncMaster worker.

mddocs/reference/worker/log_url.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This log URL might point to an Elastic instance or another logging tool such as
66
The log URL is generated based on a template configured in the configuration.
77
The configuration parameter is:
88

9-
```yaml
9+
```yaml title="config.yaml"
1010
worker:
1111
log_url_template: https://grafana.example.com?correlation_id={{ correlation_id }}&run_id={{ run.id }}
1212
```

0 commit comments

Comments
 (0)