Skip to content

Commit 2832f23

Browse files
authored
Fixed new linter errors in main (#18623)
1 parent 356697e commit 2832f23

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

ydb/docs/en/core/contributor/documentation/genres.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## {{ ydb-short-name }} documentation genres
1+
# {{ ydb-short-name }} documentation genres
22

33
This article complements [{#T}](style-guide.md) by describing the main genres used in {{ ydb-short-name }} documentation. Understanding these genres helps contributors place new content in the appropriate section and maintain a consistent structure.
44

5-
### Theory {#theory}
5+
## Theory {#theory}
66

77
**Primary goal for the reader:** build a solid knowledge foundation by understanding the fundamental concepts, architecture, and principles behind {{ ydb-short-name }}.
88

@@ -15,7 +15,7 @@ This article complements [{#T}](style-guide.md) by describing the main genres us
1515

1616
Theory documentation is primarily found in the ["Concepts"](../../concepts/index.md) section but also appears in role-specific folders when the theoretical information is relevant only to a particular audience.
1717

18-
### Guide {#guide}
18+
## Guide {#guide}
1919

2020
**Primary goal for the reader:** accomplish a specific practical task or implement a particular solution with {{ ydb-short-name }} by following instructions.
2121

@@ -29,7 +29,7 @@ Guides are practical, step-by-step instructions that help users accomplish a spe
2929

3030
Guides are primarily found in role-specific folders like ["For DevOps"](../../devops/index.md), ["For Developers"](../../dev/index.md), and ["For Security Engineers"](../../security/index.md), as well as in the ["Troubleshooting"](../../troubleshooting/index.md) section.
3131

32-
### Reference {#reference}
32+
## Reference {#reference}
3333

3434
**Primary goal for the reader:** find additional information about a specific niche topic related to {{ ydb-short-name }}.
3535

@@ -43,7 +43,7 @@ Reference documentation provides comprehensive, detailed information about {{ yd
4343

4444
Reference documentation is designed to be found as needed and is the most detailed level of documentation. It's particularly useful when users need specific information about functions, settings, or keywords. This content is primarily found in the ["Reference"](../../reference/index.md) section.
4545

46-
### FAQ {#faq}
46+
## FAQ {#faq}
4747

4848
**Primary goal for the reader:** quickly find answers to common questions encountered when working with {{ ydb-short-name }}.
4949

@@ -57,7 +57,7 @@ Frequently Asked Questions (FAQ) documentation answers common questions about {{
5757

5858
FAQ content is primarily found in the ["Questions and answers"](../../faq/index.md) section and is designed to help users who are searching for specific solutions to common situations.
5959

60-
### Recipe {#recipe}
60+
## Recipe {#recipe}
6161

6262
**Primary goal for the reader:** implement a specific, focused solution to a common issue or use case with {{ ydb-short-name }}.
6363

@@ -71,7 +71,7 @@ Recipes are short, focused mini-guides that demonstrate how to accomplish specif
7171

7272
Recipes are primarily found in the ["Recipes"](../../recipes/index.md) section, though similar content may also appear in role-specific folders.
7373

74-
### Release notes {#release-notes}
74+
## Release notes {#release-notes}
7575

7676
**Primary goal for the reader:** stay informed about new features, improvements, bug fixes, and breaking changes in {{ ydb-short-name }} releases.
7777

@@ -85,7 +85,7 @@ Release notes document changes, improvements, and fixes in each new version of {
8585

8686
Release notes are found in the ["Changelog"](../../changelog-server.md) section and help users understand what has changed between versions and decide whether to upgrade.
8787

88-
### Collection of links {#links}
88+
## Collection of links {#links}
8989

9090
**Primary goal for the reader:** discover additional resources, learning materials, and external content related to {{ ydb-short-name }}.
9191

ydb/docs/en/core/contributor/documentation/structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## {{ ydb-short-name }} documentation structure
1+
# {{ ydb-short-name }} documentation structure
22

33
This article complements [{#T}](style-guide.md). It explains the current top-level folders of the documentation and what kind of content belongs in each. As a rule of thumb, most top-level sections focus either on a specific target audience (if named "For ...") or on a specific [genre](genres.md).
44

ydb/docs/en/core/reference/docker/cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Docker stop
1+
# Docker stop
22

33
To stop {{ ydb-short-name }} in Docker, run the following command:
44

ydb/docs/en/core/reference/ydbops/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Download the binary from the releases page
66

7-
You can download binary releases from [{#T}](../../downloads/index.md#ydbops).
7+
You can download binary releases from [{#T}](../../downloads/ydb-ops.md).
88

99
## Building from source
1010

@@ -60,7 +60,7 @@ Invoke this command in the repository root folder:
6060
make build-in-docker
6161
```
6262

63-
The `ydbops` executables will be available in the `bin` folder. Binary files are generated for Linux and macOS (arm64, amd64).
63+
The `ydbops` executables will be available in the `bin` folder. Binary files are generated for Linux and macOS (arm64, amd64).
6464

6565
| Binary name | Platform |
6666
|------------------------|--------------|

ydb/docs/ru/core/contributor/documentation/genres.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Жанры документации {{ ydb-short-name }}
1+
# Жанры документации {{ ydb-short-name }}
22

33
Эта статья дополняет [{#T}](style-guide.md), описывая основные жанры статей, используемые в документации {{ ydb-short-name }}. Понимание этих жанров помогает контрибьюторам размещать новый контент в соответствующем разделе и поддерживать консистентную структуру материалов.
44

5-
### Теория {#theory}
5+
## Теория {#theory}
66

77
**Основная цель для читателя:** построить прочный фундамент знаний и прийти к пониманию основных концепций, архитектуры и принципов, на которых работает {{ ydb-short-name }}.
88

@@ -17,7 +17,7 @@
1717

1818
Теоретическая документация в основном находится в разделе [{#T}](../../concepts/index.md), но также появляется и в папках, специфичных для ролей, когда теоретическая информация релевантна только для конкретной аудитории.
1919

20-
### Руководство {#guide}
20+
## Руководство {#guide}
2121

2222
**Основная цель для читателя:** выполнить конкретную практическую задачу или реализовать определённое решение с помощью {{ ydb-short-name }}, следуя инструкциям.
2323

@@ -31,7 +31,7 @@
3131

3232
Руководства в основном находятся в папках, специфичных для ролей, таких как [{#T}](../../devops/index.md), [{#T}](../../dev/index.md) и [{#T}](../../security/index.md), а также в разделе [{#T}](../../troubleshooting/index.md).
3333

34-
### Справочник {#reference}
34+
## Справочник {#reference}
3535

3636
**Основная цель для читателя:** найти дополнительную информацию по конкретной узкой теме, связанной с {{ ydb-short-name }}.
3737

@@ -45,7 +45,7 @@
4545

4646
Справочная документация разработана для поиска по мере необходимости и является самым подробным уровнем документации. Она особенно полезна, когда пользователям нужна конкретная информация о функциях, настройках или ключевых словах. Этот контент в основном находится в разделе [{#T}](../../reference/index.md).
4747

48-
### FAQ {#faq}
48+
## FAQ {#faq}
4949

5050
**Основная цель для читателя:** быстро найти ответы на распространённые вопросы, возникающие при работе с {{ ydb-short-name }}.
5151

@@ -59,7 +59,7 @@
5959

6060
Контент FAQ в основном находится в разделе [{#T}](../../faq/index.md) и разработан для помощи пользователям, которые ищут конкретные решения для типовых ситуаций.
6161

62-
### Рецепт {#recipe}
62+
## Рецепт {#recipe}
6363

6464
**Основная цель для читателя:** реализовать конкретное, сфокусированное решение для типовой проблемы или сценария использования с помощью {{ ydb-short-name }}.
6565

@@ -73,7 +73,7 @@
7373

7474
Рецепты в основном находятся в разделе [{#T}](../../recipes/index.md), хотя похожий контент может также появляться в папках, специфичных для роли.
7575

76-
### Заметки о выпуске {#release-notes}
76+
## Заметки о выпуске {#release-notes}
7777

7878
**Основная цель для читателя:** быть в курсе новых функций, улучшений, исправлений ошибок и критических изменений в выпусках {{ ydb-short-name }}.
7979

@@ -87,7 +87,7 @@
8787

8888
Заметки о выпуске находятся в разделе [{#T}](../../changelog-server.md) и помогают пользователям понять, что изменилось между версиями, и решить, обновляться ли.
8989

90-
### Коллекция ссылок {#links}
90+
## Коллекция ссылок {#links}
9191

9292
**Основная цель для читателя:** открыть для себя дополнительные ресурсы, учебные материалы и внешний контент, связанный с {{ ydb-short-name }}.
9393

ydb/docs/ru/core/contributor/documentation/structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Структура документации {{ ydb-short-name }}
1+
# Структура документации {{ ydb-short-name }}
22

33
Эта статья дополняет [{#T}](style-guide.md). Она объясняет текущие директории верхнего уровня документации и какой контент принадлежит каждой из них. Как правило, большинство разделов верхнего уровня фокусируются либо на конкретной целевой аудитории (если названы «Для ...»), либо на конкретном [жанре](genres.md).
44

ydb/docs/ru/core/reference/docker/cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Остановка Docker
1+
# Остановка Docker
22

33
Для остановки {{ ydb-short-name }} в Docker необходимо выполнить следующую команду:
44

0 commit comments

Comments
 (0)