Skip to content

Commit 318de93

Browse files
committed
fix links with brackets inside
1 parent 31f8bcd commit 318de93

File tree

10 files changed

+17
-15
lines changed

10 files changed

+17
-15
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ But the only broker we tested is [RabbitMQ](https://www.rabbitmq.com/).
209209
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
210210
211211
# Worker options
212-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
212+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
213213
SYNCMASTER__HWM_STORE__ENABLED=true
214214
SYNCMASTER__HWM_STORE__TYPE=horizon
215215
SYNCMASTER__HWM_STORE__URL=http://horizon:8000
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Database settings { #configuration-database }
22

3-
::: syncmaster.settings.DatabaseSettings
3+
::: syncmaster.settings.database.DatabaseSettings

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Other containers (server, scheduler, worker) should be stopped while running mig
220220
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
221221
222222
# Worker options
223-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
223+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
224224
SYNCMASTER__HWM_STORE__ENABLED=true
225225
SYNCMASTER__HWM_STORE__TYPE=horizon
226226
SYNCMASTER__HWM_STORE__URL=http://horizon:8000

mddocs/docs/en/reference/frontend/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ providing users the ability to create, update, delete entitities.
202202
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
203203
204204
# Worker options
205-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
205+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
206206
SYNCMASTER__HWM_STORE__ENABLED=true
207207
SYNCMASTER__HWM_STORE__TYPE=horizon
208208
SYNCMASTER__HWM_STORE__URL=http://horizon:8000

mddocs/docs/en/reference/scheduler/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Implemented using [APScheduler](https://github.com/agronholm/apscheduler).
204204
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
205205
206206
# Worker options
207-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
207+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
208208
SYNCMASTER__HWM_STORE__ENABLED=true
209209
SYNCMASTER__HWM_STORE__TYPE=horizon
210210
SYNCMASTER__HWM_STORE__URL=http://horizon:8000

mddocs/docs/en/reference/scheduler/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ SYNCMASTER__AUTH__ACCESS_TOKEN__SECRET_KEY=generate_another_random_string
199199
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
200200
201201
# Worker options
202-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
202+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
203203
SYNCMASTER__HWM_STORE__ENABLED=true
204204
SYNCMASTER__HWM_STORE__TYPE=horizon
205205
SYNCMASTER__HWM_STORE__URL=http://horizon:8000

mddocs/docs/en/reference/server/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Implemented using [FastAPI](https://fastapi.tiangolo.com/).
202202
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
203203
204204
# Worker options
205-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
205+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
206206
SYNCMASTER__HWM_STORE__ENABLED=true
207207
SYNCMASTER__HWM_STORE__TYPE=horizon
208208
SYNCMASTER__HWM_STORE__URL=http://horizon:8000

mddocs/docs/en/reference/worker/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ For example, for slug `123-test_queue` this should be `-Q 123-test_queue`.
216216
SYNCMASTER__SCHEDULER__TRANSFER_FETCHING_TIMEOUT_SECONDS=200
217217
218218
# Worker options
219-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id={{ correlation_id }}&run_id={{ run.id }}
219+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://logs.location.example.com/syncmaster-worker?correlation_id=\{\{ correlation_id \}\}&run_id=\{\{ run.id \}\}
220220
SYNCMASTER__HWM_STORE__ENABLED=true
221221
SYNCMASTER__HWM_STORE__TYPE=horizon
222222
SYNCMASTER__HWM_STORE__URL=http://horizon:8000

mddocs/docs/en/reference/worker/log_url.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The log URL is generated based on a template configured in the configuration.
77
The configuration parameter is:
88

99
```bash
10-
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://grafana.example.com?correlation_id={{ correlation_id }}&run_id={{ run.id }}
10+
SYNCMASTER__WORKER__LOG_URL_TEMPLATE=https://grafana.example.com?correlation_id=\{\{correlation_id\}\}&run_id=\{\{run.id\}\}
1111
```
1212

1313
In this example, run logs can be retrieved by either its correlation id `x-request-id` in http headers, or by `Run.Id` field value.

mkdocs.yml renamed to mddocs/mkdocs.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
site_name: My Docs
22
#site_name: Horizon Docs
3-
docs_dir: 'mddocs/en/docs' # Where to find the English markdown files
4-
#site_dir: '../../generated/en' # Where to put the English HTML files
3+
docs_dir: 'docs/en' # Where to find the English markdown files
4+
#site_dir: 'generated/en' # Where to put the English HTML files
55

66

77
extra_css:
88
- assets/stylesheets/autodoc_pydantic.css # CSS is shared by all languages
99

1010
plugins:
11-
- autorefs
12-
- literate-nav:
13-
nav_file: nav.md
11+
- autorefs:
12+
resolve_closest: true
13+
scan_paths:
14+
- docs/en
15+
# - literate-nav:
16+
# nav_file: nav.md
1417
- mkdocstrings:
1518
default_handler: python
1619
handlers:
@@ -59,4 +62,3 @@ markdown_extensions:
5962
- name: mermaid
6063
class: mermaid
6164
format: !!python/name:pymdownx.superfences.fence_code_format
62-

0 commit comments

Comments
 (0)