[DOP-27550] docs(mddocs): add en docs from docs_rework#417
[DOP-27550] docs(mddocs): add en docs from docs_rework#417annamikhailovapsk wants to merge 2 commits intodevelopfrom
Conversation
Coverage Report •
|
|
|
||
| - Create `openlineage.yml` file with content like: | ||
|
|
||
| ```yaml title="KafkaTransport" |
There was a problem hiding this comment.
В mkdocs есть вкладки? По идее это должны быть две вкладки для 2 вариантов интеграции, а не два блока с примерами друг за другом. А то люди запутаются...
| .env.docker:1:5,23 | ||
| --8<-- | ||
|
|
||
| - Add scripts to crontab: |
There was a problem hiding this comment.
Наверное список из одного элемента не нужен
There was a problem hiding this comment.
А если это продолжение предыдущего списка, то он будет прерван блоком ###
| ```yaml hl_lines="140-151" linenums="1" | ||
| ----8<---- | ||
| docker-compose.yml | ||
| ----8<---- | ||
| ``` |
There was a problem hiding this comment.
| ```yaml hl_lines="140-151" linenums="1" | |
| ----8<---- | |
| docker-compose.yml | |
| ----8<---- | |
| ``` | |
| ----8<---- | |
| docker-compose.yml | |
| ----8<---- |
Оборачивать literal include в блок ``` неправильно. Проблема встречается больше одного раза
| [debug][configuration-http2kafka-debug] | ||
|
|
||
| <!-- TODO: Check the place --> | ||
| <!-- ::: data_rentgen.http2kafka.settings.Http2KafkaApplicationSettings --> |
There was a problem hiding this comment.
Не совсем понятен текст TODO, тут что-то не работает?
| <!-- | ||
| inherited_members: true | ||
| heading_[Incremental batch strategy][incremental-batch-strategy-0] 3 | ||
| show_root_heading: true | ||
| --> | ||
|
|
||
| <!-- ## Http2Kafka Static Files --> |
There was a problem hiding this comment.
Этот TODO и закомментированные блоки актуальны?
| <!-- TODO: include | ||
|
|
||
| ```{raw} html | ||
| :file: ../../_static/swagger_http2kafka.html | ||
| ``` | ||
| --> |
| ```{eval-rst} | ||
| .. dropdown:: Interaction schema |
There was a problem hiding this comment.
Кажется тут достаточно обычного ```plantuml блока, а не eval-rst
| This auth schema (not actually a AuthProvider) allows to access API endpoints using {ref}`personal-tokens`. | ||
| If enabled, it has higher priority than AuthProvider. | ||
|
|
||
| :::{note} |
There was a problem hiding this comment.
Синтаксис admonition точно правильный?
| ## Basic Configuration | ||
|
|
||
| ```{eval-rst} | ||
| .. autopydantic_model:: data_rentgen.server.settings.auth.personal_token.PersonalTokenSettings |
There was a problem hiding this comment.
Тут кажется должен быть обычный ::: class
| Firstly, install pre-commit hooks: | ||
|
|
||
| ```bash | ||
| pre-commit install --install-hooks |
There was a problem hiding this comment.
Эта часть слегка устарела https://github.com/MTSWebServices/data-rentgen/blob/develop/CONTRIBUTING.rst#enable-pre-commit-hooks
| @@ -0,0 +1,20 @@ | |||
| # Minimal makefile for Sphinx documentation | |||
| @@ -0,0 +1 @@ | |||
| If some run uses the same table as both input and output (e.g. merging duplicates or performing some checks before writing), DataRentgen excludes `dataset1 -> dataset1` relations from lineage with `granularity=DATASET`. | |||
There was a problem hiding this comment.
Файлы в docs/changelog/next_release/*.rst удаляются при релизе, и превращаются в docs/changelog/$VERSION.rst. После конвертации остались и старые, и новые
2 participants
Change Summary
Created en folder documentation with documents in markdown
Checklist