docs: Large editorial pass — terminology, formatting, markup#198
Draft
valeria-brazhnikova wants to merge 12 commits into
Draft
docs: Large editorial pass — terminology, formatting, markup#198valeria-brazhnikova wants to merge 12 commits into
valeria-brazhnikova wants to merge 12 commits into
Conversation
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Avtandilko
approved these changes
May 17, 2026
| ##### Выбор пользователя для обновления учётных данных | ||
|
|
||
| По умолчанию учётные данные обновляются для пользователя, который запустил действие (инициатора). Чтобы обновить учётные данные другого пользователя, включите опцию **обновлять учётные данные конкретного пользователя** и выберите нужного пользователя. | ||
| По умолчанию учётные данные обновляются для пользователя, который запустил действие (инициатора). Чтобы обновить учётные данные другого пользователя, включите опцию обновлять учётные данные конкретного пользователя и выберите нужного пользователя. |
Collaborator
There was a problem hiding this comment.
"обновлять учётные данные конкретного пользователя" - это название заголовка в интерфейсе, надо как-то его выделять
Member
There was a problem hiding this comment.
имеет смысл обернуть в алерт info
Lada7878
reviewed
May 19, 2026
| ##### Выбор пользователя для обновления учётных данных | ||
|
|
||
| По умолчанию учётные данные обновляются для пользователя, который запустил действие (инициатора). Чтобы обновить учётные данные другого пользователя, включите опцию **обновлять учётные данные конкретного пользователя** и выберите нужного пользователя. | ||
| По умолчанию учётные данные обновляются для пользователя, который запустил действие (инициатора). Чтобы обновить учётные данные другого пользователя, включите опцию обновлять учётные данные конкретного пользователя и выберите нужного пользователя. |
Member
There was a problem hiding this comment.
имеет смысл обернуть в алерт info
|
|
||
| Если параметры отсутствуют, откройте ресурс на редактирование и добавьте их на вкладке «Параметры» ресурса, нажав кнопку «Добавить параметр». | ||
|
|
||
| ### Ресурс «Сервисы» | ||
|
|
||
| У вас должен быть создан второй ресурс для хранения информации о созданных сервисах. В рамках инструкции он называется `Сервисы`, но вы можете выбрать любое удобное для вас название. Если ресурса еще нет, [создайте его](#создание-ресурса). | ||
| У вас должен быть создан второй ресурс для хранения информации о созданных сервисах. В рамках инструкции он называется `Сервисы`, но вы можете выбрать любое удобное для вас название. Если ресурса ещё нет, [создайте его](#создание-ресурса). |
Member
There was a problem hiding this comment.
В заголовке кавычки, а далее - бэктики. Надо к одному виду привести.
| - **Идентификатор**: идентификатор создаваемой сущности. Например, можно использовать выражение `{{ replaceChar .path_with_namespace "/" "-" }}` | ||
|
|
||
| - **Примечание**: является лишь примером, а не строгой необходимостью. Данное выражение преобразует путь с пространством имен (`.path_with_namespace` из спецификации [Projects API GitLab](https://docs.gitlab.com/api/projects/#get-a-single-project)), заменяя слеши на дефисы для получения уникального ID. | ||
| - «Идентификатор»: идентификатор создаваемой сущности. Например, можно использовать выражение `{{ replaceChar .path_with_namespace "/" "-" }}`. |
Member
There was a problem hiding this comment.
тут очень много алертов, если смотреть на тесте. Вся страница в алертах.
Co-authored-by: Lada Lysenko <127337005+Lada7878@users.noreply.github.com> Co-authored-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com> Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
Signed-off-by: Valeria Brazhnikova <valeria.brazhnikova@flant.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Include edits from #196
Summary
Large documentation pass following an editorial review: alignment with the project style guide and glossary, unified table and list formatting, removal of excessive bold emphasis, and meaningful link anchors.
48 files changed, ~1.8k lines of changes.
What was done
1. Terminology and consistency
DDP→Deckhouse Development Platform (DDP).неймспейс,веб-интерфейс,IP-адрес,файлы cookie, etc.moduleStatusandd8Editionremoved from front matter.Deckhouse Kubernetes Platform,Kafka,PostgreSQL).2. Yo-fication (
е→ё)Bulk replacement in common forms:
учётные,создаётся,за счёт,путём,обновлённой,вернёт,найдёте, etc. Legal text and Residual risk sections were not touched.3. Punctuation and typos
и т.д./и т.п.→и т. д./и т. п.Сихронизация→Синхронизация,кажого→каждого,при при,платформане подставляет→платформа не подставляет, etc.4. Structural fixes
1. 1. 1.(Markdown auto-numbering).> ...blockquotes converted to Hugo{{< alert >}}shortcodes where applicable.Content-Security-Policy,X-Frame-Options, etc.) wrapped in` `.5. Tables
Да/Нет/Обязательно.Да/Нет/Обязательноafter spec clarification.опционально→Опционально); technical literals and identifiers left as-is.6. Cleanup of
**bold emphasis**~1000 cases of excessive bold emphasis processed by rule:
`inline code`.«chevrons»in RU and"quotes"in EN.Kubernetes,GitLab,PostgreSQL,Dex, ...) — bold removed without replacement.admin/actions/types.ru.md, where**incorrectly wrapped inline code.7. Meaningful link anchors
Following the pattern of
release-notes/v1.4.0.ru.mdandv1.5.0.ru.md:[подробнее],[документация],[документе],[здесь],[см.],[См.]replaced with descriptive anchors — widget/action/section name or a key phrase (68 fixes across 10 files).GitlabProjectsparameters table (admin/datasources/types.ru.md), the "Возможные значения" and "По умолчанию" columns now contain concrete values instead of duplicate links.Affected areas
admin/— actions, architecture, datasources, examples, external-services, healthchecks, processes, security, widgets;user/— ai-assistant, catalog, credentials, interface, mcp-server, properties, teams-users, templating;product-info/— functional, licensing, lifecycle, staff, tech-support;release-notes/— v1.0.0–v1.4.0.Verification
make lint-markdown— clean._index.md/_index.ru.mdwere intentionally left unchanged.Checklist
make lint-markdownpasses