You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ydb/docs/en/core/concepts/topic.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ A source ID is an arbitrary string up to 2048 characters long. This is usually t
129
129
#### Sample source IDs {#source-id-examples}
130
130
131
131
| Type | ID | Description |
132
-
--- | --- | ---
132
+
|--- | --- | ---|
133
133
| File | Server ID | Files are used to store application logs. In this case, it's convenient to use the server ID as a source ID. |
134
134
| User actions | ID of the class of user actions, such as "viewing a page", "making a purchase", and so on. | It's important to handle user actions in the order they were performed by the user. At the same time, there is no need to handle every single user action in one application. In this case, it's convenient to group user actions by class. |
135
135
@@ -140,7 +140,7 @@ A message group ID is an arbitrary string up to 2048 characters long. This is us
140
140
#### Sample message group IDs {#group-id-examples}
141
141
142
142
| Type | ID | Description |
143
-
--- | --- | ---
143
+
|--- | --- | ---|
144
144
| File | Full file path | All data from the server and the file it hosts will be sent to the same partition. |
145
145
| User actions | User ID | It's important to handle user actions in the order they were performed. In this case, it's convenient to use the user ID as a source ID. |
146
146
@@ -153,9 +153,9 @@ Sequence numbers are not used if [no-deduplication mode](#no-dedup) is enabled.
| File | Offset of transferred data from the beginning of a file | You can't delete lines from the beginning of a file, since this will lead to skipping some data as duplicates or losing some data. |
158
-
| DB table | Auto-increment record ID |
158
+
| DB table | Auto-increment record ID ||
159
159
160
160
## Message retention period {#retention-time}
161
161
@@ -168,13 +168,13 @@ When transferring data, the producer app indicates that a message can be compres
168
168
Supported codecs are explicitly listed in each topic. When making an attempt to write data to a topic with a codec that is not supported, a write error occurs.
Copy file name to clipboardExpand all lines: ydb/docs/en/core/contributor/documentation/genres.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
##{{ ydb-short-name }} documentation genres
1
+
# {{ ydb-short-name }} documentation genres
2
2
3
3
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.
4
4
5
-
###Theory {#theory}
5
+
## Theory {#theory}
6
6
7
7
**Primary goal for the reader:** build a solid knowledge foundation by understanding the fundamental concepts, architecture, and principles behind {{ ydb-short-name }}.
8
8
@@ -15,7 +15,7 @@ This article complements [{#T}](style-guide.md) by describing the main genres us
15
15
16
16
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.
17
17
18
-
###Guide {#guide}
18
+
## Guide {#guide}
19
19
20
20
**Primary goal for the reader:** accomplish a specific practical task or implement a particular solution with {{ ydb-short-name }} by following instructions.
21
21
@@ -29,7 +29,7 @@ Guides are practical, step-by-step instructions that help users accomplish a spe
29
29
30
30
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.
31
31
32
-
###Reference {#reference}
32
+
## Reference {#reference}
33
33
34
34
**Primary goal for the reader:** find additional information about a specific niche topic related to {{ ydb-short-name }}.
35
35
@@ -43,7 +43,7 @@ Reference documentation provides comprehensive, detailed information about {{ yd
43
43
44
44
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.
45
45
46
-
###FAQ {#faq}
46
+
## FAQ {#faq}
47
47
48
48
**Primary goal for the reader:** quickly find answers to common questions encountered when working with {{ ydb-short-name }}.
49
49
@@ -57,7 +57,7 @@ Frequently Asked Questions (FAQ) documentation answers common questions about {{
57
57
58
58
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.
59
59
60
-
###Recipe {#recipe}
60
+
## Recipe {#recipe}
61
61
62
62
**Primary goal for the reader:** implement a specific, focused solution to a common issue or use case with {{ ydb-short-name }}.
63
63
@@ -71,7 +71,7 @@ Recipes are short, focused mini-guides that demonstrate how to accomplish specif
71
71
72
72
Recipes are primarily found in the ["Recipes"](../../recipes/index.md) section, though similar content may also appear in role-specific folders.
73
73
74
-
###Release notes {#release-notes}
74
+
## Release notes {#release-notes}
75
75
76
76
**Primary goal for the reader:** stay informed about new features, improvements, bug fixes, and breaking changes in {{ ydb-short-name }} releases.
77
77
@@ -85,7 +85,7 @@ Release notes document changes, improvements, and fixes in each new version of {
85
85
86
86
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.
87
87
88
-
###Collection of links {#links}
88
+
## Collection of links {#links}
89
89
90
90
**Primary goal for the reader:** discover additional resources, learning materials, and external content related to {{ ydb-short-name }}.
Copy file name to clipboardExpand all lines: ydb/docs/en/core/contributor/documentation/structure.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
##{{ ydb-short-name }} documentation structure
1
+
# {{ ydb-short-name }} documentation structure
2
2
3
3
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).
0 commit comments