docs(mddocs): add en mddocs from docs_rework by annamikhailovapsk · Pull Request #183 · MTSWebServices/horizon

annamikhailovapsk · 2026-03-12T12:02:12Z

Change Summary

Created en folder documentation with documents in markdown

Related issue number

[DOP-28349]

Checklist

[ x ] Commit message and PR title is comprehensive
[ x ] Keep the change as small as possible
[ x ] Unit and integration tests for the changes exist
[ x ] Tests pass on CI and coverage does not decrease
[ x ] Documentation reflects the changes where applicable
docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
(see CONTRIBUTING.rst for details.)
[ x ] My PR is ready to review.

for more information, see https://pre-commit.ci

github-actions · 2026-03-12T12:06:40Z

Coverage Report •

File	Stmts	Miss	Branch	BrPart	Cover	Missing
TOTAL	2528	202	308	83	92%

report-only-changed-files is enabled. No files were changed during this commit :)

dolfinus · 2026-03-12T12:14:07Z

mddocs/en/backend/auth/cached_ldap.md

+            deactivate "Client"
+        @enduml
+```
+<!--


Здесь и в dummy.md mermaid диаграмма закомментирована, в ldap.md нет

dolfinus · 2026-03-12T12:14:45Z

mddocs/en/backend/auth/ldap.md

+
+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


Может тут имеет смысл использовать admonition вместо заголовка?

dolfinus · 2026-03-12T12:16:35Z

mddocs/en/backend/auth/ldap.md

+- you can search for user by `uid`, e.g. `(uid={login})` or `(sAMAccountName={login})`
+- you can search for user by several attributes, e.g. `(|(uid={login})(mail={login}@domain.com))`
+- you can filter for entries, like `(&(uid={login})(objectClass=person)`
+- you can filter for users matching a specific group or some other condition, like `(&(uid={login})(memberOf=cn=MyPrettyGroup,ou=Groups,dc=mycompany,dc=com))`


Suggested change

- you can search for user by `uid`, e.g. `(uid={login})` or `(sAMAccountName={login})`

- you can search for user by several attributes, e.g. `(|(uid={login})(mail={login}@domain.com))`

- you can filter for entries, like `(&(uid={login})(objectClass=person)`

- you can filter for users matching a specific group or some other condition, like `(&(uid={login})(memberOf=cn=MyPrettyGroup,ou=Groups,dc=mycompany,dc=com))`

- search for user by `uid`, e.g. `(uid={login})` or `(sAMAccountName={login})`

- search for user by several attributes, e.g. `(|(uid={login})(mail={login}@domain.com))`

- filter for entries, like `(&(uid={login})(objectClass=person)`

- filter for users matching a specific group or some other condition, like `(&(uid={login})(memberOf=cn=MyPrettyGroup,ou=Groups,dc=mycompany,dc=com))`

Это ведь делает AuthProvider, не пользователь, не совсем понятно кто есть you. Возможно это проблема в исходной доке

dolfinus · 2026-03-12T12:17:08Z

mddocs/en/_static/custom.css

@@ -0,0 +1,3 @@
+.logo {


Пути должны быть вида mkdocs/ вместо mkdocs/en/

dolfinus · 2026-03-12T12:18:44Z

mddocs/en/backend/configuration/monitoring.md

+## Example metrics
+
+```default
+# Generated in CI


Что-то странное, здесь и ниже по идее должен подставляться .prom файл, который CI наполняет примером в момент сборки доки

dolfinus · 2026-03-12T12:20:06Z

mddocs/en/backend/install.md

+
+### `docker-compose.yml`
+
+```default


Копировать docker-compose.yml не надо, нужно его подставлять и выделять нужные строки, которые важны для конкретного компонента

dolfinus · 2026-03-12T12:21:07Z

mddocs/en/backend/openapi.md

+
+<!-- this page cannot be properly rendered in local environment, it should be build in CI first -->
+<!--!DOCTYPE html>
+<html lang="en">


Не совсем понятно, зачем тут кусок html внутри .md, и почему он закомментирован

dolfinus · 2026-03-12T12:21:43Z

mddocs/en/changelog/0.0.10.md

@@ -0,0 +1,5 @@
+# 0.0.10 (2024-01-22) { #0.0.10 }


Есть подозрение что якоря не могут содержать точки, и они должны выглядеть как version-0-0-10. Но это нужно проверить

dolfinus · 2026-03-12T12:22:47Z

mddocs/en/changelog/DRAFT.md

+```{eval-rst}
+.. towncrier-draft-entries:: |release| [UNRELEASED]


Можно временно это дропнуть, и позже перейти на интеграцию mkdocs с towncrier

dolfinus · 2026-03-12T12:24:51Z

mddocs/en/client/schemas/hwm_history.md

+<!--
+```{eval-rst}
+.. autopydantic_model:: HWMHistoryResponseV1
+    :model-show-field-summary: false
+```
+-->


Кажется эти закомментированные блоки нам не нужны, не?

dolfinus · 2026-03-12T12:25:22Z

mddocs/en/client/schemas/user.md

+```{eval-rst}
+.. currentmodule:: horizon.commons.schemas.v1.user
+``` -->
+<!-- TODO: fix docstring extraction -->


Проблема не исправилась?

dolfinus · 2026-03-12T12:26:19Z

mddocs/en/client/exceptions.md

+
+## Base
+
+### *class* horizon.commons.exceptions.base.ApplicationError


Из docstring это не извлекается?

dolfinus · 2026-03-12T12:27:01Z

mddocs/en/design/entities.md

+    @enduml
+```
+
+```mermaid


mermaid пустой, он нужен?

dolfinus · 2026-03-12T12:27:30Z

mddocs/en/conf.py

@@ -0,0 +1,167 @@
+# SPDX-FileCopyrightText: 2025-present MTS PJSC


Это кусок конфига для sphinx, он точно здесь нужен? Как и mkdocs/Makefile и mkdocs/make.bat

Anna Mikhaylova and others added 2 commits March 12, 2026 14:54

docs(mddocs): add en mddocs from docs_rework

7b2de94

[pre-commit.ci] auto fixes from pre-commit.com hooks

c06ec6e

for more information, see https://pre-commit.ci

dolfinus assigned annamikhailovapsk Mar 12, 2026

dolfinus self-requested a review March 12, 2026 12:09

dolfinus added the ci:skip-changelog Add this label to skip changelog file check label Mar 12, 2026

dolfinus reviewed Mar 12, 2026

View reviewed changes

mddocs/en/_static/custom.css

@@ -0,0 +1,3 @@

.logo {

Copy link

Member

dolfinus Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Пути должны быть вида mkdocs/ вместо mkdocs/en/

dolfinus reviewed Mar 12, 2026

View reviewed changes

mddocs/en/design/entities.md

@enduml

```

```mermaid

Copy link

Member

dolfinus Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mermaid пустой, он нужен?

dolfinus reviewed Mar 12, 2026

View reviewed changes


		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

		```{eval-rst}
		.. towncrier-draft-entries:: \|release\| [UNRELEASED]


		## Base

		### class horizon.commons.exceptions.base.ApplicationError

		@@ -0,0 +1,167 @@
		# SPDX-FileCopyrightText: 2025-present MTS PJSC

Conversation

annamikhailovapsk commented Mar 12, 2026

Change Summary

Related issue number

Checklist

Uh oh!

github-actions bot commented Mar 12, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dolfinus Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dolfinus Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dolfinus Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dolfinus Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dolfinus Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dolfinus Mar 12, 2026 •

edited

Loading

dolfinus Mar 12, 2026 •

edited

Loading

dolfinus Mar 12, 2026 •

edited

Loading

dolfinus Mar 12, 2026 •

edited

Loading

dolfinus Mar 12, 2026 •

edited

Loading