Skip to content

Commit 56dc3b5

Browse files
authored
[docs] enable yfmlint and fix some syntax issues it finds (#8427)
1 parent 7402492 commit 56dc3b5

File tree

452 files changed

+3607
-3556
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

452 files changed

+3607
-3556
lines changed

ydb/docs/.yfmlint

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
11
log-levels:
2-
YFM001: 'disabled'
2+
MD001: 'error' # Heading levels should only increment by one level at a time
3+
MD002: 'error' # First heading should be a top-level heading
4+
MD003: 'disabled' # Heading style
5+
MD004: 'disabled' # Unordered list style
6+
MD005: 'error' # Inconsistent indentation for list items at the same level
7+
MD006: 'error' # Consider starting bulleted lists at the beginning of the line
8+
MD007: 'error' # Unordered list indentation
9+
MD009: 'error' # Trailing spaces
10+
MD010: 'error' # Hard tabs
11+
MD011: 'error' # Reversed link syntax
12+
MD012: 'disabled' # Multiple consecutive blank lines
13+
MD013: 'disabled' # Line length
14+
MD014: 'disabled' # Dollar signs used before commands without showing output
15+
MD018: 'disabled' # No space after hash on atx style heading
16+
MD019: 'disabled' # Multiple spaces after hash on atx style heading
17+
MD020: 'disabled' # No space inside hashes on closed atx style heading
18+
MD021: 'disabled' # Multiple spaces inside hashes on closed atx style heading
19+
MD022: 'disabled' # Headings should be surrounded by blank lines
20+
MD023: 'disabled' # Headings must start at the beginning of the line
21+
MD024: 'disabled' # Multiple headings with the same content
22+
MD025: 'error' # Multiple top-level headings in the same document
23+
MD026: 'disabled' # Trailing punctuation in heading
24+
MD027: 'disabled' # Multiple spaces after blockquote symbol
25+
MD028: 'disabled' # Blank line inside blockquote
26+
MD029: 'disabled' # Ordered list item prefix
27+
MD030: 'disabled' # Spaces after list markers
28+
MD031: 'disabled' # Fenced code blocks should be surrounded by blank lines
29+
MD032: 'disabled' # Lists should be surrounded by blank lines
30+
MD033: 'disabled' # Inline HTML
31+
MD034: 'disabled' # Bare URL used
32+
MD035: 'disabled' # Horizontal rule style
33+
MD036: 'disabled' # Emphasis used instead of a heading
34+
MD037: 'error' # Spaces inside emphasis markers
35+
MD038: 'error' # Spaces inside code span elements
36+
MD039: 'error' # Spaces inside link text
37+
MD040: 'disabled' # Fenced code blocks should have a language specified
38+
MD041: 'disabled' # First line in a file should be a top-level heading
39+
MD042: 'error' # No empty links
40+
MD043: 'disabled' # Required heading structure
41+
MD044: 'disabled' # Proper names should have the correct capitalization
42+
MD045: 'disabled' # Images should have alternate text (alt text)
43+
MD046: 'disabled' # Code block style
44+
MD047: 'disabled' # Files should end with a single newline character
45+
MD048: 'disabled' # Code fence style
46+
MD049: 'disabled' # Emphasis style should be consistent
47+
MD050: 'disabled' # Strong style should be consistent
48+
MD051: 'error' # Link fragments should be valid
49+
MD052: 'error' # Reference links and images should use a label that is defined
50+
MD053: 'error' # Link and image reference definitions should be needed
51+
MD054: 'error' # Link and image style
52+
MD055: 'error' # Table pipe style
53+
MD056: 'error' # Table column count
54+
55+
YFM001: 'error' # Inline code length
56+
YFM002: 'error' # No header found in the file for the link text
57+
YFM003: 'error' # Link is unreachable
58+
YFM004: 'error' # Table not closed
59+
YFM005: 'error' # Tab list not closed
60+
YFM006: 'error' # Term definition duplicated
61+
YFM007: 'error' # Term used without definition
62+
YFM008: 'error' # Term inside definition not allowed
63+
YFM009: 'error' # Term definition used not at the end of file
64+
65+
# Inline code length
66+
YFM001:
67+
maximum: 140
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% note info %}
22

3-
This а article is currently in development and will soon be available on the website.
3+
This а article is currently in development and will soon be available on the website.
44

55
{% endnote %}

ydb/docs/en/core/changelog-cli.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@ Released on June 24, 2024. To update to version **2.10.0**, select the [Download
1212
* Added replication description support in the `ydb scheme describe` and `ydb scheme ls` commands.
1313
* Added big datetime types support: `Date32`, `Datetime64`, `Timestamp64`, `Interval64`.
1414
* `ydb workload` commands rework:
15-
* Added the `--clear` option to the `init` subcommand, allowing tables from previous runs to be removed before workload initialization.
16-
* Added the `ydb workload * import` command to prepopulate tables with initial content before executing benchmarks.
15+
16+
* Added the `--clear` option to the `init` subcommand, allowing tables from previous runs to be removed before workload initialization.
17+
* Added the `ydb workload * import` command to prepopulate tables with initial content before executing benchmarks.
1718

1819
**Backward incompatible changes:**
1920

2021
* `ydb workload` commands rework:
21-
* The `--path` option was moved to a specific workload level. For example: `ydb workload tpch --path some/tables/path init ...`.
22-
* The `--store=s3` option was changed to `--store=external-s3` in the `init` subcommand.
22+
23+
* The `--path` option was moved to a specific workload level. For example: `ydb workload tpch --path some/tables/path init ...`.
24+
* The `--store=s3` option was changed to `--store=external-s3` in the `init` subcommand.
2325

2426

2527
**Bug fixes:**
@@ -33,7 +35,7 @@ Released on April 25, 2024. To update to version **2.9.0**, select the [Download
3335
**Features:**
3436

3537
* Improved query logical plan tables: added colors, more information, fixed some bugs.
36-
* The verbose option `-v`` is supported for `ydb workload` commands to provide debug information.
38+
* The verbose option `-v` is supported for `ydb workload` commands to provide debug information.
3739
* Added an option to run `ydb workload tpch` with an S3 source to measure [federated queries](concepts/federated_query/index.md) performance.
3840
* Added the `--rate` option for `ydb workload` commands to control the transactions (or requests) per second limit.
3941
* Added the `--use-virtual-addressing` option for S3 import/export, allowing the switch to [virtual hosting of buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html) for the S3 path layout.
@@ -246,16 +248,18 @@ Release date: September 20, 2022. To update to version **2.0.0**, select the [Do
246248
**Features:**
247249

248250
* Added the ability to work with topics:
249-
* `ydb topic create`: Create a topic.
250-
* `ydb topic alter`: Update a topic.
251-
* `ydb topic write`: Write data to a topic.
252-
* `ydb topic read`: Read data from a topic.
253-
* `ydb topic drop`: Delete a topic.
251+
252+
* `ydb topic create`: Create a topic.
253+
* `ydb topic alter`: Update a topic.
254+
* `ydb topic write`: Write data to a topic.
255+
* `ydb topic read`: Read data from a topic.
256+
* `ydb topic drop`: Delete a topic.
254257

255258
* Added a new type of load testing:
256-
* `ydb workload kv init`: Create a table for kv load testing.
257-
* `ydb workload kv run`: Apply one of three types of load: run multiple `UPSERT` sessions, run multiple `INSERT` sessions, or run multiple sessions of GET requests by primary key.
258-
* `ydb workload kv clean`: Delete a test table.
259+
260+
* `ydb workload kv init`: Create a table for kv load testing.
261+
* `ydb workload kv run`: Apply one of three types of load: run multiple `UPSERT` sessions, run multiple `INSERT` sessions, or run multiple sessions of GET requests by primary key.
262+
* `ydb workload kv clean`: Delete a test table.
259263

260264
* Added the ability to disable current active profile (see the `ydb config profile deactivate` command).
261265
* Added the ability to delete a profile non-interactively with no commit (see the `--force` option under the `ydb config profile remove` command).

ydb/docs/en/core/changelog-server.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -219,32 +219,37 @@ Release date: October 12, 2022. To update to version **22.4**, select the [Downl
219219
**What's new:**
220220

221221
* {{ ydb-short-name }} Topics and Change Data Capture (CDC):
222-
* Introduced the new Topic API. {{ ydb-short-name }} [Topic](concepts/topic.md) is an entity for storing unstructured messages and delivering them to various subscribers.
223-
* Added support for the Topic API to the [{{ ydb-short-name }} CLI](reference/ydb-cli/topic-overview.md) and [SDK](reference/ydb-sdk/topic.md). The Topic API provides methods for message streaming writes and reads as well as topic management.
224-
* Added the ability to [capture table updates](concepts/cdc.md) and send change messages to a topic.
222+
223+
* Introduced the new Topic API. {{ ydb-short-name }} [Topic](concepts/topic.md) is an entity for storing unstructured messages and delivering them to various subscribers.
224+
* Added support for the Topic API to the [{{ ydb-short-name }} CLI](reference/ydb-cli/topic-overview.md) and [SDK](reference/ydb-sdk/topic.md). The Topic API provides methods for message streaming writes and reads as well as topic management.
225+
* Added the ability to [capture table updates](concepts/cdc.md) and send change messages to a topic.
225226

226227
* SDK:
227-
* Added the ability to handle topics in the {{ ydb-short-name }} SDK.
228-
* Added official support for the database/sql driver for working with {{ ydb-short-name }} in Golang.
228+
229+
* Added the ability to handle topics in the {{ ydb-short-name }} SDK.
230+
* Added official support for the database/sql driver for working with {{ ydb-short-name }} in Golang.
229231

230232
* Embedded UI:
231-
* The CDC changefeed and the secondary indexes are now displayed in the database schema hierarchy as separate objects.
232-
* Improved the visualization of query explain plan graphics.
233-
* Problem storage groups have more visibility now.
234-
* Various improvements based on UX research.
233+
234+
* The CDC changefeed and the secondary indexes are now displayed in the database schema hierarchy as separate objects.
235+
* Improved the visualization of query explain plan graphics.
236+
* Problem storage groups have more visibility now.
237+
* Various improvements based on UX research.
235238

236239
* Query Processing:
237-
* Added Query Processor 2.0, a new subsystem to execute OLTP queries with significant improvements compared to the previous version.
238-
* Improved write performance by up to 60%, and by up to 10% for reads.
239-
* Added the ability to include a NOT NULL restriction for YDB primary keys when creating tables.
240-
* Added support for renaming a secondary index online without shutting the service down.
241-
* Improved the query explain view that now also includes fields for the physical operators.
240+
241+
* Added Query Processor 2.0, a new subsystem to execute OLTP queries with significant improvements compared to the previous version.
242+
* Improved write performance by up to 60%, and by up to 10% for reads.
243+
* Added the ability to include a NOT NULL restriction for YDB primary keys when creating tables.
244+
* Added support for renaming a secondary index online without shutting the service down.
245+
* Improved the query explain view that now also includes fields for the physical operators.
242246

243247
* Core:
244-
* For read only transactions, added consistent snapshot support that does not conflict with write transactions.
245-
* Added BulkUpsert support for tables with asynchronous secondary indexes.
246-
* Added TTL support for tables with asynchronous secondary indexes.
247-
* Added compression support for data export to S3.
248-
* Added an audit log for DDL statements.
249-
* Added support for authentication with static credentials.
250-
* Added system tables for query performance troubleshooting.
248+
249+
* For read only transactions, added consistent snapshot support that does not conflict with write transactions.
250+
* Added BulkUpsert support for tables with asynchronous secondary indexes.
251+
* Added TTL support for tables with asynchronous secondary indexes.
252+
* Added compression support for data export to S3.
253+
* Added an audit log for DDL statements.
254+
* Added support for authentication with static credentials.
255+
* Added system tables for query performance troubleshooting.

ydb/docs/en/core/concepts/_includes/index/intro.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
title: "YDB. DBMS overview"
3-
description: "YDB is a horizontally scalable distributed fault-tolerant DBMS. YDB is designed to meet high performance requirements, for example, a typical server can handle dozens of thousands of requests per second. The system is designed to handle hundreds of petabytes of data."
4-
---
5-
61
# {{ ydb-short-name }} overview
72

83
*{{ ydb-short-name }}* is a horizontally scalable distributed fault-tolerant DBMS. {{ ydb-short-name }} is designed for high performance with a typical server being capable of handling tens of thousands of queries per second. The system is designed to handle hundreds of petabytes of data. {{ ydb-short-name }} can operate in single data center and geo-distributed (cross data center) modes on a cluster of thousands of servers.

0 commit comments

Comments
 (0)