Skip to content

Commit e620336

Browse files
committed
clear md from rst
1 parent aab08ec commit e620336

12 files changed

Lines changed: 49 additions & 34 deletions

File tree

mddocs/docs/en/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Changelog
22

3-
[0.1.o][0.1.o]
4-
[0.2.o][0.2.o]
3+
[0.1.0][0.1.0]
4+
[0.2.0][0.2.0]
55
[0.2.1][0.2.1]
6-
[0.3.o][0.3.o]
6+
[0.3.0][0.3.0]
77
[0.3.1][0.3.1]

mddocs/docs/en/changelog/0.1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# 0.1.0 (2024-12-25)
1+
# 0.1.0 (2024-12-25) { #0.1.0 }
22

33
🎉 Data.Rentgen first release! 🎉

mddocs/docs/en/changelog/0.2.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 0.2.0 (2025-03-25)
1+
# 0.2.0 (2025-03-25) { #0.2.0 }
22

33
## TL;DR
44

mddocs/docs/en/changelog/0.2.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 0.2.1 (2025-04-07)
1+
# 0.2.1 (2025-04-07) { #0.2.1 }
22

33
## Improvements
44

mddocs/docs/en/changelog/0.3.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 0.3.0 (2025-07-04)
1+
# 0.3.0 (2025-07-04) { #0.3.0 }
22

33
## Features
44

mddocs/docs/en/changelog/0.3.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 0.3.1 (2025-07-04)
1+
# 0.3.1 (2025-07-04) { #0.3.1 }
22

33
## Breaking changes
44

mddocs/docs/en/integrations/flink1/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Using [OpenLineage integration with Apache Flink 1.x](https://openlineage.io/doc
99

1010
## Limitations
1111

12-
- Only `standalone-job` (application mode) is supported, but not `jobmanager` (session mode): [https://github.com/OpenLineage/OpenLineage/issues/2150](OpenLineageissue)
12+
- Only `standalone-job` (application mode) is supported, but not `jobmanager` (session mode): (https://github.com/OpenLineage/OpenLineage/issues/2150)[OpenLineageissue]
1313

1414
## Entity mapping
1515

mddocs/docs/en/reference/architecture.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
Data.Rentgen is build using following components:
66

77
- [OpenLineage](https://openlineage.io/docs/) clients & integrations with third-party modules (e.g. Apache Spark, Apache Airflow).
8-
- [`message-broker`](message-broker), receiving events in JSON format.
9-
- [`message-consumer`](message-consumer), parsing JSON messages.
10-
- [`database`](database) for storing consumed & cleaned up data.
11-
- [`server`](server), serving database data.
12-
- [`frontend`](frontend), accessing REST API to navigate created entities & lineage graph.
13-
- [`http2kafka`](http2kafka) (optional), proxy for sending OpenLineage events to Kafka using HTTP API.
8+
- [`message-broker`][message-broker], receiving events in JSON format.
9+
- [`message-consumer`][message-consumer], parsing JSON messages.
10+
- [`database`][database] for storing consumed & cleaned up data.
11+
- [`server`][server], serving database data.
12+
- [`frontend`][frontend], accessing REST API to navigate created entities & lineage graph.
13+
- [`http2kafka`][http2kafka] (optional), proxy for sending OpenLineage events to Kafka using HTTP API.
1414

1515
## Architecture diagram
1616

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

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ Migration script is a thin wrapper around [Alembic cli](https://alembic.sqlalche
1616

1717
## Partitions
1818

19-
After migrations are performed, it is required to run [`create-partitions-cli`](create-partitions-cli) which creates partitions for some tables in the database.
19+
After migrations are performed, it is required to run [`create-partitions-cli`][create-partitions-cli] which creates partitions for some tables in the database.
2020
By default, it creates monthly partitions, for current and next month. This can be changed by overriding command args.
2121

2222
This script should run on schedule, depending on partitions granularity.
2323
Scheduling can be done by adding a dedicated entry to [crontab](https://help.ubuntu.com/community/CronHowto).
2424

25-
It's strongly recommended also to add old partitions cleanup script to cron [`cleanup-partitions-cli`](cleanup-partitions-cli).
25+
It's strongly recommended also to add old partitions cleanup script to cron [`cleanup-partitions-cli`][cleanup-partitions-cli].
2626
Scheduling setup is same is for creating of partitions.
2727

2828
## Analytic views
2929

30-
Along with migrations few analytics views are created. These are managed by [`refresh-analytic-views-cli`](refresh-analytic-views-cli), and should be executed by schedule.
30+
Along with migrations few analytics views are created. These are managed by [`refresh-analytic-views-cli`][refresh-analytic-views-cli], and should be executed by schedule.
3131

3232
## Seeding
3333

34-
By default, database is created with no data. To seed database with some examples, use [`db-seed-cli`](db-seed-cli).
34+
By default, database is created with no data. To seed database with some examples, use [`db-seed-cli`][db-seed-cli].
3535

3636
## Requirements
3737

@@ -64,19 +64,21 @@ By default, database is created with no data. To seed database with some example
6464

6565
Options can be set via `.env` file or `environment` section in `docker-compose.yml`
6666

67-
=== "docker-compose.yml"
67+
??? note "docker-compose.yml"
6868

69-
```yaml
70-
.. literalinclude:: ../../../docker-compose.yml
71-
:emphasize-lines: 1-69,176
72-
```
69+
```yaml hl_lines="1-69 176" linenums="1"
70+
----8<----
71+
docker-compose.yml
72+
----8<----
73+
```
7374

74-
=== ".env.docker"
75+
??? note ".env.docker"
7576

76-
```yaml
77-
.. literalinclude:: ../../../.env.docker
78-
:emphasize-lines: 1-5,23
79-
```
77+
```ini hl_lines="1-5 23" linenums="1"
78+
----8<----
79+
.env.docker
80+
----8<----
81+
```
8082

8183
- Add scripts to crontab:
8284

@@ -110,7 +112,7 @@ By default, database is created with no data. To seed database with some example
110112
...
111113
```
112114

113-
- Configure [`Database connection`](configuration-database) using environment variables, e.g. by creating `.env` file:
115+
- Configure [`Database connection`][configuration-database] using environment variables, e.g. by creating `.env` file:
114116

115117
```console title="/some/.env"
116118

@@ -177,5 +179,5 @@ By default, database is created with no data. To seed database with some example
177179
[Create partitions cli][create-partitions-cli]
178180
[Cleanup partitions cli][cleanup-partitions-cli]
179181
[Refresh analytic views cli][refresh-analytic-views-cli]
180-
[Seed cli][seed-cli]
181-
[Structure][structure]
182+
[Seed cli][db-seed-cli]
183+
[Structure][database-structure]

mddocs/docs/en/reference/http2kafka/configuration/debug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ File ".../site-packages/uvicorn/middleware/proxy_headers.py", line 84, in __call
3838

3939
## Print debug logs on backend
4040

41-
See [`configuration-server-logging`](configuration-server-logging), but replace log level `INFO` with `DEBUG`.
41+
See [`configuration-server-logging`][configuration-server-logging], but replace log level `INFO` with `DEBUG`.
4242

4343
## Fill up `X-Request-ID` header on backend
4444

0 commit comments

Comments
 (0)