docs(mddocs): add en mddocs from docs_rework#183
docs(mddocs): add en mddocs from docs_rework#183annamikhailovapsk wants to merge 5 commits intodevelopfrom
Conversation
Coverage Report •
|
| deactivate "Client" | ||
| @enduml | ||
| ``` | ||
| <!-- |
There was a problem hiding this comment.
Здесь и в dummy.md mermaid диаграмма закомментирована, в ldap.md нет
|
|
||
| ### `docker-compose.yml` | ||
|
|
||
| ```default |
There was a problem hiding this comment.
Копировать docker-compose.yml не надо, нужно его подставлять и выделять нужные строки, которые важны для конкретного компонента
| @@ -0,0 +1,5 @@ | |||
| # 0.0.10 (2024-01-22) { #0.0.10 } | |||
There was a problem hiding this comment.
Есть подозрение что якоря не могут содержать точки, и они должны выглядеть как version-0-0-10. Но это нужно проверить
| ```{eval-rst} | ||
| .. currentmodule:: horizon.commons.schemas.v1.user | ||
| ``` --> | ||
| <!-- TODO: fix docstring extraction --> |
|
|
||
| ## Base | ||
|
|
||
| ### *class* horizon.commons.exceptions.base.ApplicationError |
There was a problem hiding this comment.
Из docstring это не извлекается?
| @@ -0,0 +1,167 @@ | |||
| # SPDX-FileCopyrightText: 2025-present MTS PJSC | |||
There was a problem hiding this comment.
Это кусок конфига для sphinx, он точно здесь нужен? Как и mkdocs/Makefile и mkdocs/make.bat
…ervices/horizon into feature/mddocs-en-folder
for more information, see https://pre-commit.ci
| <<<<<<< HEAD:mddocs/conf.py | ||
| ======= |
|
|
||
| After successful auth, username is saved to backend database. It is then used for creating audit records for any object change, see `changed_by` field. | ||
|
|
||
| !!! warning "" |
| ```default | ||
| # development usage only |
There was a problem hiding this comment.
Посмотри на все вхождения default, скорее всего с ними та же проблема - вместо подстановок из файла (пример) копировалось их содержимое
|
|
||
| ## Example metrics | ||
|
|
||
| ```default |
There was a problem hiding this comment.
Это точно работает? Три бэктика означают блок кодом, который не воспринимается парсером как markdown. И внутри этого блока мы зачем-то используем подстановку !include.
Да и почему default? Посте бэктиков пишется название языка
2 participants
Change Summary
Created en folder documentation with documents in markdown
Related issue number
[DOP-28349]
Checklist
docs/changelog/next_release/<pull request or issue id>.<change type>.rstfile added describing change(see CONTRIBUTING.rst for details.)